diff --git a/README.md b/README.md index e08b8f6b..ebaffdd6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ -# spacecat-audit-worker -SpaceCat Audit Worker for auditing edge delivery sites. +# SpaceCat Audit Worker + +> SpaceCat Audit Worker for auditing edge delivery sites. + +## Status +[![codecov](https://img.shields.io/codecov/c/github/adobe-rnd/spacecat-audit-worker.svg)](https://codecov.io/gh/adobe-rnd/spacecat-audit-worker) +[![CircleCI](https://img.shields.io/circleci/project/github/adobe-rnd/spacecat-audit-worker.svg)](https://circleci.com/gh/adobe-rnd/spacecat-audit-worker) +[![GitHub license](https://img.shields.io/github/license/adobe-rnd/spacecat-audit-worker.svg)](https://github.com/adobe-rnd/spacecat-audit-worker/blob/master/LICENSE.txt) +[![GitHub issues](https://img.shields.io/github/issues/adobe-rnd/spacecat-audit-worker.svg)](https://github.com/adobe-rnd/spacecat-audit-worker/issues) +[![LGTM Code Quality Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/adobe-rnd/spacecat-audit-worker.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/adobe-rnd/spacecat-audit-worker) +[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) + +## Installation + +```bash +$ npm install @adobe/spacecat-audit-worker +``` + +## Usage + +See the [API documentation](docs/API.md). + +## Development + +### Build + +```bash +$ npm install +``` + +### Test + +```bash +$ npm test +``` + +### Lint + +```bash +$ npm run lint +```