diff options
Diffstat (limited to 'packages/sra-api/README.md')
| -rw-r--r-- | packages/sra-api/README.md | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/packages/sra-api/README.md b/packages/sra-api/README.md index 8e3486bdf..552e37eeb 100644 --- a/packages/sra-api/README.md +++ b/packages/sra-api/README.md @@ -1,9 +1,31 @@ ## @0xproject/sra-api -Contains the Standard Relayer API swagger spec. +Contains the Standard Relayer API [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). + +The package distributes both a javascript object version and a json version. + +## Usage + +``` +import { api } from '@0xproject/sra-api'; +``` ## Installation +``` +yarn install +``` + +## Development + +You can start a development server that will serve a [ReDoc](https://github.com/Rebilly/ReDoc) documentation instance. It uses the `api.json` file from `lib/` (you must have built at least once with `yarn build` or `yarn build-json`) that is based on the `api` object exported from `src`. + +``` +yarn develop +``` + +The process will watch for changes, but will not hot-reload so you must refresh the page to see the changes. + ## Contributing We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. |