Skip to content

Instantly share code, notes, and snippets.

@timothyis
Last active December 7, 2017 00:41
Show Gist options
  • Save timothyis/3dc7cf12f96121f45ea8a299ffeabda4 to your computer and use it in GitHub Desktop.
Save timothyis/3dc7cf12f96121f45ea8a299ffeabda4 to your computer and use it in GitHub Desktop.
An example of a hyper plugin readme for the Hyper Store

Hyper Plugin

A description of a Hyper plugin that describes a lot of things about what it does in a short time.

Example Image

Installation

A bunch of text about how to install, including:
With A line of code
and

A block
of code

Options

A paragraph that explains the options of a plugin.

Another paragraph directly under a paragraph to test spacing. Including A link!

Misc Readme Elements

Blockquotes

A blockquote With some text

Unordered List

  • Testing
  • Unordered
  • Lists

Ordered List

  1. Testing
  2. Ordered
  3. Lists

Nested List

  • Testing
    • Nested
    • Lists
  • Testing more

Code blocks

const asyncYo = () => {
  let someData = await fetch(somePlace.website)
  return await someData
}

Tables

Stole from Github docs

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell
Command Description
git status List all new or modified files
git diff Show file differences that haven't been staged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment