| 1 | # {{PascalName}}
|
| 2 |
|
| 3 | Describe what this component does!
|
| 4 |
|
| 5 | ## Usage
|
| 6 | ```js
|
| 7 | import React from 'react'
|
| 8 | import {{PascalName}} from '{{name}}'
|
| 9 | React.render(<{{PascalName}} />, document.createElement('div'))
|
| 10 | ```
|
| 11 |
|
| 12 | ```css
|
| 13 | @import "{{name}}";
|
| 14 | ```
|
| 15 |
|
| 16 | ## Props
|
| 17 | ### `<String> option` **Required**
|
| 18 | Defaults to "hi". Controls X.
|
| 19 |
|
| 20 | ## CSS Variables
|
| 21 |
|
| 22 | ## CSS Classes
|
| 23 | CSS classes that might be useful for the outside world. Probably not too useful if this is mostly a JS component.
|
| 24 |
|
| 25 | ## Tests
|
| 26 | Tests are in [tape](https://github.com/substack/tape). You can run them with:
|
| 27 |
|
| 28 | ```bash
|
| 29 | browserify -t babelify --debug | smokestack
|
| 30 | ```
|
| 31 |
|
| 32 | ## Developing
|
| 33 | Install [ribcage](https://github.com/Techwraith/ribcage)
|
| 34 |
|
| 35 | ```sh
|
| 36 | npm i -g ribcage
|
| 37 | ribcage preview .
|
| 38 | # run with client side js enabled
|
| 39 | ribcage preview . -s
|
| 40 | ```
|
| 41 |
|
| 42 | Open [http://localhost:4001/default](http://localhost:4001/default)
|
| 43 |
|