${description}
[💡 Image Pro Tip: Paste an image into a GitHub issue comment (any repo). It will give back the markdown you can paste above. You don't even need to submit it!]
[Give a more detailed explanation of what your package does here. A few sentences or a few paragraphs. This is your elevator pitch area.]
$ npm i ${repo-name}or
$ yarn add ${repo-name}[describe a simple use of the thingie that you are pitching. keep it short]
const thingie = createThingie(config);[describe what parameters your package/function takes]
| Parameter | Description |
|---|---|
foo |
A foo thingie (boolean). Default = true. |
bar |
A bar thingie (string). Default = bar. |
[describe what is returned]
| Key | Description |
|---|---|
blah |
A boolean containing the current value of blah. |
[Write something here describing the sample code below. The example code SHOULD WORK!]
import React from 'react';
import { createThingie } from '${repo-name}';
const Thingie = createThingie();
const MyThingie = () => {
// Do some stuff
return <Thingie>Return some JSX</Thingie>;
};
export default MyThingie;You can view/edit the ${repo-name} demo app on CodeSandbox.
${license} Licensed
[Optional footer information here. Maybe thank a friend. Maybe plug your Twitter account. Whatever.]