Skip to content

Commit 6b466d8

Browse files
.
1 parent 9e2e31b commit 6b466d8

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,17 @@ We strongly recommend that you use the accompanying CLI [create-react-library](h
1414

1515
## Features
1616

17-
There are some existing React library boilerplates, but none of them fulfilled the following goals which we set out to accomplish:
18-
19-
- Comes with an easy-to-use CLI [create-react-library](https://github.com/transitive-bullshit/create-react-library) for creating new modules
20-
- Support all modern JS language features for component development out of the box
21-
- Build process to convert source to `umd` and `es` module formats for publishing to npm
22-
- Comes with an `example` app using a standard [create-react-app](https://github.com/facebookincubator/create-react-app), serving 2 purposes
23-
- Local, hot-reload server for developing your module
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
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)
29-
- Note that CSS support will be a noop if you're using css-in-js
30-
- Testing with [Jest](https://facebook.github.io/jest/), using `react-scripts` from `create-react-app`
31-
- Sourcemap creation enabled by default
32-
- Thorough documentation written by someone who cares :heart_eyes:
17+
- Easy-to-use CLI [create-react-library](https://github.com/transitive-bullshit/create-react-library)
18+
- Transpiles all modern JS features
19+
- Bundles `umd` and `es` module formats
20+
- [create-react-app](https://github.com/facebookincubator/create-react-app) for example usage and local dev
21+
- [Rollup](https://rollupjs.org/) for build process
22+
- [Babel](https://babeljs.io/) for transpilation
23+
- [Jest](https://facebook.github.io/jest/) testing
24+
- Supports complicated peer-dependencies
25+
- Supports CSS modules
26+
- Sourcemap creation
27+
- Thorough documentation :heart_eyes:
3328

3429
## Manual Setup
3530

0 commit comments

Comments
 (0)