diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..521c374 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +Copyright (c) Glen Wider + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index bb86f85..74a2583 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,31 @@ -# react-code-review-editor +# react-code-review-editor +The react-code-review-editor is a React component aiming to provide functionality for code review purposes. +It supports a variety of languages. -Currently in development. +![review-editor-screenshot](./review-editor-screenshot.png) -## how to import (while not published) +##Features +- [x] display syntax highlighted code +- [x] create and display comments inside the code +- [x] create and display results +- [x] different comment types with their own annotation symbols for better usability +- [x] keyboard shortcuts +##Development +For using and getting to know the component 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 \ No newline at end of file +* the library has been added to your `package.json` and `node_modules` folder and can now be used + +## License +The source code for all packages in ./src is licensed under the MIT license, which you can find in the LICENSE +file. \ No newline at end of file diff --git a/review-editor-screenshot.png b/review-editor-screenshot.png new file mode 100644 index 0000000..30c41d6 Binary files /dev/null and b/review-editor-screenshot.png differ