diff --git a/README.md b/README.md index 8c402dd..bac3da1 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,28 @@ -# Coverage REST Client +# coverage-rest-client An experimental library that wraps [Coverage or Coverage Collection objects](https://github.com/Reading-eScience-Centre/coverage-jsapi) and runs operations like subsetting through a REST API that follows the ["Coverage Data REST API Core Specification"](https://github.com/Reading-eScience-Centre/coverage-restapi) instead of loading the complete data and doing it locally. -## Example using covjson-reader +## Usage -We use the [covjson-reader](https://github.com/Reading-eScience-Centre/covjson-reader) library -to load a [CoverageJSON](https://github.com/neothemachine/coveragejson) document which then is wrapped with the coverage-rest-client library in order to support pagination and run operations like subsetting or collection filtering server-side. +coverage-rest-client can be used in browsers only. -```js +Standalone minified and source versions can be found in the [releases section](https://github.com/Reading-eScience-Centre/coverage-rest-client/releases). The library can also be used within npm, currently as a GitHub dependency only due to its experimental character. + +As an example, we use the [covjson-reader](https://github.com/Reading-eScience-Centre/covjson-reader) library +to load a [CoverageJSON](https://github.com/neothemachine/coveragejson) document which then is wrapped with the coverage-rest-client library in order to support pagination and run operations like subsetting or collection filtering server-side: +```html + + +