commit | a36d901a771331a18a79f3bb4eaf6ee05823acff | [log] [tgz] |
---|---|---|
author | Randall Leeds <randall@apache.org> | Sun Feb 02 00:15:40 2020 -0800 |
committer | Randall Leeds <randall@apache.org> | Mon Feb 03 16:33:16 2020 -0800 |
tree | 5c2586a08f073d7606bc29e29b3ebfb7bcb41e83 | |
parent | df8a1586c5caf4cba1ba0c63ebae0822301519df [diff] |
Add incubation disclaimer
Apache Annotator provides annotation enabling code for browsers, servers, and humans.
We‘re currently pre-releasing development copies of each library that makes up the sum total of Apache Annotator’s code. You can grab any of them from our npm organization.
$ # for example... $ npm install --save @annotator/dom
We use Lerna to juggle the various Apache Annotator libraries. If you‘d like to contribute, you’ll need the following:
$ yarn install
$ yarn test
$ yarn start
Once the test server has started, you can browse a local demo, and run tests in a browser by visiting http://localhost:8080/
.
If you have any Web Annotation Data Model JSON documents, you can validate them using the validate
script:
$ yarn validate --url https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json
With the --url
option you can pass in a URL or a local path to a JSON file.
Valid:
https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json
Invalid:
https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/incorrect/anno1.json
Apache License 2.0
Apache Annotator is currently undergoing incubation at The Apache Software Foundation.
See the accompanying DISCLAIMER file for details.