diff --git a/README.md b/README.md new file mode 100644 index 0000000..a1fbc4d --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Digital fingerprint of plastics - API + +This is the API to access the database of the digital fingerprint of plastics project. + +## API documentation + +The API is documented using the Open API Specification 3.0.2 and hosted together with the API under the `/api` path + +## Testing + +Testing is done with mocha and can be executed using `npm test`.