-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from knowankit/docs/update-readme
Update readme
- Loading branch information
Showing
2 changed files
with
28 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,26 @@ | ||
# init-react-library | ||
# 📦 build-react-npm | ||
|
||
> CLI for creating reusable, modern React libraries using Webpack and create-react-app. | ||
## Features 🚀 | ||
|
||
- A modern and easy to use CLI | ||
- Generates modern JS feature files | ||
- Bundles `commonjs` and `es` module formats | ||
- [create-react-app](https://github.com/facebookincubator/create-react-app) for example usage and local dev | ||
- [Webpack](https://webpack.js.org/) for bundling | ||
- [Babel](https://babeljs.io/) for transpiling | ||
- [Jest](https://facebook.github.io/jest/) for testing | ||
- Supports complicated peer-dependencies | ||
- Optional support for TypeScript | ||
- Sourcemap creation | ||
- Publish github pages with one command | ||
- Easy to build and test your component with the example template | ||
|
||
## Install globally | ||
|
||
This package requires `node >= 12`. | ||
|
||
```bash | ||
npm install -g build-react-npm | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters