From 5316ae6459b0d2690c6d5396b1d8221bfc2d232c Mon Sep 17 00:00:00 2001 From: Glen Wider Date: Mon, 31 May 2021 14:08:06 +0200 Subject: [PATCH] update readme --- README.md | 14 +++++++------- package.json | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 74a2583..32f88d0 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index 8278197..8f4e562 100644 --- a/package.json +++ b/package.json @@ -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", @@ -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"