aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sra-api/README.md
diff options
context:
space:
mode:
authorfragosti <francesco.agosti93@gmail.com>2018-08-08 04:50:56 +0800
committerfragosti <francesco.agosti93@gmail.com>2018-08-08 04:50:56 +0800
commit57a44291233548da9785aec3cde92171342c9eb3 (patch)
tree90d19c24a8e07b3ee0b4835c3067dac9aba82617 /packages/sra-api/README.md
parent3b542bf356f14e7bfd5bbd740d2df55ff64e1309 (diff)
downloaddexon-0x-contracts-57a44291233548da9785aec3cde92171342c9eb3.tar.gz
dexon-0x-contracts-57a44291233548da9785aec3cde92171342c9eb3.tar.zst
dexon-0x-contracts-57a44291233548da9785aec3cde92171342c9eb3.zip
Add discharge config and deploy
Diffstat (limited to 'packages/sra-api/README.md')
-rw-r--r--packages/sra-api/README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/packages/sra-api/README.md b/packages/sra-api/README.md
index 552e37eeb..23eefe7d8 100644
--- a/packages/sra-api/README.md
+++ b/packages/sra-api/README.md
@@ -4,6 +4,8 @@ Contains the Standard Relayer API [OpenAPI Spec](https://github.com/OAI/OpenAPI-
The package distributes both a javascript object version and a json version.
+A deployed [ReDoc](https://github.com/Rebilly/ReDoc) static site with the API can be found here http://sra-api.com.s3-website-us-east-1.amazonaws.com/.
+
## Usage
```
@@ -21,7 +23,7 @@ yarn install
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
+yarn watch_without_deps
```
The process will watch for changes, but will not hot-reload so you must refresh the page to see the changes.
@@ -60,6 +62,22 @@ Or continuously rebuild on change:
PKG=@0xproject/sra-api yarn watch
```
+### Static Site
+
+We also [host a static HTML version of the docs on S3](http://sra-api.com.s3-website-us-east-1.amazonaws.com/) for easy sharing.
+
+To build the website run
+
+```
+yarn build-site
+```
+
+To build and deploy the site run
+
+```
+yarn deploy-site
+```
+
### Clean
```bash