diff options
author | fragosti <francesco.agosti93@gmail.com> | 2018-07-27 05:52:23 +0800 |
---|---|---|
committer | fragosti <francesco.agosti93@gmail.com> | 2018-07-27 05:52:23 +0800 |
commit | efa67d87aa4f8d9d57883ee85b59f5aaf211eb12 (patch) | |
tree | b38844359d2df47a4ae3fab4a64f86062349a5ca /packages/sra-api/README.md | |
parent | 4fe410a277f13bc637ffe1c1c5b023d957a2bef8 (diff) | |
download | dexon-sol-tools-efa67d87aa4f8d9d57883ee85b59f5aaf211eb12.tar dexon-sol-tools-efa67d87aa4f8d9d57883ee85b59f5aaf211eb12.tar.gz dexon-sol-tools-efa67d87aa4f8d9d57883ee85b59f5aaf211eb12.tar.bz2 dexon-sol-tools-efa67d87aa4f8d9d57883ee85b59f5aaf211eb12.tar.lz dexon-sol-tools-efa67d87aa4f8d9d57883ee85b59f5aaf211eb12.tar.xz dexon-sol-tools-efa67d87aa4f8d9d57883ee85b59f5aaf211eb12.tar.zst dexon-sol-tools-efa67d87aa4f8d9d57883ee85b59f5aaf211eb12.zip |
Rename to sra-api
Diffstat (limited to 'packages/sra-api/README.md')
-rw-r--r-- | packages/sra-api/README.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/packages/sra-api/README.md b/packages/sra-api/README.md new file mode 100644 index 000000000..8e3486bdf --- /dev/null +++ b/packages/sra-api/README.md @@ -0,0 +1,57 @@ +## @0xproject/sra-api + +Contains the Standard Relayer API swagger spec. + +## Installation + +## Contributing + +We welcome improvements and fixes from the wider community! 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 + +To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: + +```bash +PKG=@0xproject/sra-api yarn build +``` + +Or continuously rebuild on change: + +```bash +PKG=@0xproject/sra-api yarn watch +``` + +### Clean + +```bash +yarn clean +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test +``` |