aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorfragosti <francesco.agosti93@gmail.com>2018-07-27 07:58:27 +0800
committerfragosti <francesco.agosti93@gmail.com>2018-07-27 07:58:27 +0800
commit78a4b9897ce7ead2fdfe0778949b57f6ae1d9e83 (patch)
tree873dab0573ffba589a3e1ef7bcc9c181467e6c84
parentc1fcbe3f04714c5ad1c560d88d03fe6e3e251864 (diff)
downloaddexon-sol-tools-78a4b9897ce7ead2fdfe0778949b57f6ae1d9e83.tar
dexon-sol-tools-78a4b9897ce7ead2fdfe0778949b57f6ae1d9e83.tar.gz
dexon-sol-tools-78a4b9897ce7ead2fdfe0778949b57f6ae1d9e83.tar.bz2
dexon-sol-tools-78a4b9897ce7ead2fdfe0778949b57f6ae1d9e83.tar.lz
dexon-sol-tools-78a4b9897ce7ead2fdfe0778949b57f6ae1d9e83.tar.xz
dexon-sol-tools-78a4b9897ce7ead2fdfe0778949b57f6ae1d9e83.tar.zst
dexon-sol-tools-78a4b9897ce7ead2fdfe0778949b57f6ae1d9e83.zip
Add to README
-rw-r--r--packages/sra-api/README.md24
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.