Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
glenwid committed May 31, 2021
1 parent 0aa2b1a commit 5316ae6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ It supports a variety of languages.
- [x] keyboard shortcuts

##Development
For using and getting to know the component through storybook examples:
For developing and getting to know the components through storybook examples:
```shell script
git clone https://github.com/codefreak/react-code-review-editor.git
yarn install
yarn storybook
```

## How to import to your own project (while not published on npm)
* clone this repo
* run `yarn build`
* this builds and packages the `./lib`
* in your repo that you want to use the library in type `npm i local/path/to/the/package.tgz`
* the library has been added to your `package.json` and `node_modules` folder and can now be used
## Installation
For using the components:
```shell script
yarn add react-code-review-editor
yarn install
```

## License
The source code for all packages in ./src is licensed under the MIT license, which you can find in the LICENSE
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-code-review-editor",
"version": "0.1.0",
"version": "1.0.0",
"main": "lib/index.js",
"module": "lib/index.esm.js",
"types": "lib/index.d.ts",
Expand All @@ -11,7 +11,7 @@
"lib/index.esm.js",
"lib/index.js"
],
"private": true,
"private": false,
"peerDependencies": {
"react": "^17.0.2",
"react-dom": "^17.0.2"
Expand Down

0 comments on commit 5316ae6

Please sign in to comment.