commit | 3232f443f25ebe3c83cbc83f5997d74e9cb8786b | [log] [tgz] |
---|---|---|
author | Benjamin Young <byoung2@wiley.com> | Wed Oct 09 11:42:48 2019 -0400 |
committer | BigBlueHat <byoung@bigbluehat.com> | Thu Oct 10 15:28:27 2019 -0400 |
tree | 64d3fc821e03e915513c8e10ccb8ba4b8f460bcb | |
parent | 16ab8f46836996aeb44ea927a5b00e0f8e2a87e1 [diff] |
Add CODE_OF_CONDUCT.md pointing to the ASF CoC
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