aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sra-report/README.md
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-02-22 16:30:35 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-02-23 05:12:44 +0800
commit42ecc087cbd3558258107fbce645441955416497 (patch)
treebb5f6fe7cad0cdfa2799219282c69b99fab7b0ee /packages/sra-report/README.md
parent0e95fd0b9b9fc340854ba39c63059edb3b1a1be8 (diff)
downloaddexon-sol-tools-42ecc087cbd3558258107fbce645441955416497.tar
dexon-sol-tools-42ecc087cbd3558258107fbce645441955416497.tar.gz
dexon-sol-tools-42ecc087cbd3558258107fbce645441955416497.tar.bz2
dexon-sol-tools-42ecc087cbd3558258107fbce645441955416497.tar.lz
dexon-sol-tools-42ecc087cbd3558258107fbce645441955416497.tar.xz
dexon-sol-tools-42ecc087cbd3558258107fbce645441955416497.tar.zst
dexon-sol-tools-42ecc087cbd3558258107fbce645441955416497.zip
Implement initial sra-report command line tool
Diffstat (limited to 'packages/sra-report/README.md')
-rw-r--r--packages/sra-report/README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/packages/sra-report/README.md b/packages/sra-report/README.md
new file mode 100644
index 000000000..18802f06a
--- /dev/null
+++ b/packages/sra-report/README.md
@@ -0,0 +1,53 @@
+# SRA Report
+
+This package allows you to generate reports detailing an endpoint's [standard relayer API HTTP specification](https://github.com/0xProject/standard-relayer-api/blob/master/http/v0.md) compliance.
+
+## Installation
+
+`yarn add -g @0xproject/sra-report`
+
+## Usage
+
+```
+abi-gen
+Options:
+ --help Show help [boolean]
+ --version Show version number [boolean]
+ --url, -u API endpoint to test for standard relayer API compliance
+ [string] [required]
+ --output, -o, --out Folder where to write the reports [string]
+ --network-id, -n ID of the network that the API is serving orders from
+ [number] [default: 1]
+```
+
+## Contributing
+
+We strongly encourage that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
+
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
+
+### Install Dependencies
+
+If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
+
+```bash
+yarn config set workspaces-experimental true
+```
+
+Then install dependencies
+
+```bash
+yarn install
+```
+
+### Build
+
+```bash
+yarn build
+```
+
+### Lint
+
+```bash
+yarn lint
+```