README.md
Annotations (built with [Draft.js](https://draftjs.org))
---
[](https://travis-ci.org/cltk/annotations)
[](https://codeclimate.com/github/cltk/annotations)
[](https://codeclimate.com/github/cltk/annotations/coverage)
[](https://codeclimate.com/github/cltk/annotations)
A library for adding notes to text
## Requirements
- Node.js >= 8.0.0 (the library might work on older versions)
## Docs
https://cltk.org/annotations
## Developing
Clone the repository, then install the dependencies by running
```shell
$ npm start
```
Make sure the tests pass:
```shell
$ npm test
```
To develop with live previews of the library's components, run
```shell
$ npm run storybook
```
The storybook environment (which doubles as interactive documentation)
is available by default at http://localhost:6006.
## LICENSE
The MIT License (MIT)
Copyright (c) 2017-2018 CLTK
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.