Skip to content

Commit

Permalink
Merge pull request #7 from knowankit/docs/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
knowankit authored Sep 20, 2021
2 parents 7cb6c05 + a17b8f9 commit 48b60c6
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 3 deletions.
27 changes: 26 additions & 1 deletion README.md
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
```
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@knowankit/build-react-npm",
"version": "0.0.1",
"description": "Create your react npm library",
"description": "Create your react npm library and publish it in no time",
"main": "src/index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
Expand All @@ -26,7 +26,7 @@
"bugs": {
"url": "https://github.com/knowankit/build-react-npm/issues"
},
"homepage": "https://github.com/knowankit/build-react-npmy#readme",
"homepage": "https://github.com/knowankit/build-react-npm#readme",
"dependencies": {
"arg": "^5.0.1",
"chalk": "^4.1.2",
Expand Down

0 comments on commit 48b60c6

Please sign in to comment.