|
1 | 1 | # create-react-library
|
2 | 2 |
|
3 |
| -> CLI for easily publishing modern React modules with Rollup and example usage via create-react-app. |
| 3 | +> CLI for easily publishing modern React libraries with Rollup and example usage via create-react-app. |
4 | 4 |
|
5 | 5 | [](https://www.npmjs.com/package/create-react-library) [](https://standardjs.com)
|
6 | 6 |
|
|
13 | 13 | </p>
|
14 | 14 |
|
15 | 15 |
|
16 |
| -The CLI is based on this [boilerplate](https://github.com/transitive-bullshit/react-modern-library-boilerplate), which you can optionally read in-depth about [here](https://hackernoon.com/publishing-baller-react-modules-2b039d84bce7). |
| 16 | +The CLI is based on this [boilerplate](https://github.com/transitive-bullshit/react-modern-library-boilerplate), which you can optionally read about [here](https://hackernoon.com/publishing-baller-react-modules-2b039d84bce7). |
17 | 17 |
|
18 | 18 | ## Features
|
19 | 19 |
|
20 |
| -- Support all modern JS language features for component development out of the box |
| 20 | +- Supports all modern JS language features for component development out of the box |
21 | 21 | - Build process to convert source to `umd` and `es` module formats for publishing to npm
|
22 | 22 | - Comes with an `example` app using a standard [create-react-app](https://github.com/facebookincubator/create-react-app), serving 2 purposes
|
23 | 23 | - Local, hot-reload server for developing your module
|
24 | 24 | - Easily publishable to github pages so users can quickly play with your module
|
25 |
| -- Use [Rollup](https://rollupjs.org/) for build process and [Babel](https://babeljs.io/) for transpilation |
| 25 | +- Uses [Rollup](https://rollupjs.org/) for build process and [Babel](https://babeljs.io/) for transpilation |
26 | 26 | - See the [blog post](https://hackernoon.com/publishing-baller-react-modules-2b039d84bce7) for an explanation of Rollup vs Webpack
|
27 |
| -- Allow the use of `npm` modules within your library, either as dependencies or peer-dependencies |
28 |
| -- Support importing CSS in your components (with css modules enabled by default) |
| 27 | +- Allows the use of `npm` modules within your library, either as dependencies or peer-dependencies |
| 28 | +- Supports importing CSS in your components (with css modules enabled by default) |
29 | 29 | - Note that CSS support will be a noop if you're using css-in-js
|
30 | 30 | - Testing with [Jest](https://facebook.github.io/jest/), using `react-scripts` from `create-react-app`
|
31 | 31 | - Sourcemap creation enabled by default
|
|
0 commit comments