Project Title (or image/logo)
🔥 One liner description of what your repo does
One to two paragraph project descrption of what it does.
(example gif demo of what your project does)
Features
- it does this
- it also does that
Examples
- Example 1 (as of now, codesandbox is best because it's so extensible)
Installation
Just a simple explanation of how to install it.
yarn add your-package or npm i -S your-package
Usage
Some Example
Potentially a short summary below, but not 100% necessary.
This would be
some code block
Another Example
Potentially a short summary below, but not 100% necessary here either.
This would be
some other block
of code
Todos
I like to put these here because 1. it helps me remember what I need to do, and 2. sometimes people might want to contribute and this gives them very clear todos. 😊
- tests
yarn test - github page
- publish to NPM
yarn publish - continuous integration (awesome continuous integration list)
- make more exmaples on codesandbox
- document in a different language
- badges awesome list 1, awesome list 2
- add keywords to package.json for google searchability
- add "topics" to repo by clicking the "Manage topics" button at the top of your repo page. (similar to keywords)
- add Social Preview so when you share on social media it will not show your github profile picture (go to Settings tab)
- check out the awesome readme list to see others
- checkout this example readme I really like it