A tool for annotating texts using Draft.js
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.storybook
__mocks__
src
stories
.babelrc
.codeclimate.yml
.flowconfig
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
package-lock.json
package.json
yarn.lock

README.md

Annotations (built with Draft.js)

Build Status Code Climate Test Coverage Issue Count

A library for adding notes to text

Requirements

  • Node.js >= 7.0.0 (the library may work on older versions)
  • Yarn

Docs

https://cltk.org/annotations

Developing

Clone the repository, then install the dependencies by running

$ yarn

Make sure the tests pass:

$ yarn test

To develop with live previews of the library's components, run

$ yarn 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 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.