commit | 8660e896f5f4f74216d019cd57e31e10a920305c | [log] [tgz] |
---|---|---|
author | Randall Leeds <randall@apache.org> | Fri Jan 03 14:38:02 2020 -0800 |
committer | Randall Leeds <randall@apache.org> | Fri Jan 03 14:38:02 2020 -0800 |
tree | 13de41e0cf77492d87aa11ac604da0fef21bd0ab | |
parent | e7ef57fbccd68965a950139dc1cfc3a3844a4493 [diff] |
Change top-level package name Remove the package scope from the top-level package. The top-level package is not currently published. Therefore, this name is quite meaningless, but stripping the package scope means that it could be published as a meta-package or the whole project could switch to not being a monorepo.
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