aboutsummaryrefslogtreecommitdiffstats
path: root/packages/forwarder-helper/README.md
diff options
context:
space:
mode:
authorfragosti <francesco.agosti93@gmail.com>2018-08-25 02:14:34 +0800
committerfragosti <francesco.agosti93@gmail.com>2018-08-25 02:14:34 +0800
commit9ffddb47b8c9187401c1df6e5d5953caad3a9274 (patch)
tree44344c48c860ce24f424f6d504e24f8f1a5560f6 /packages/forwarder-helper/README.md
parent7bcaac4e1080ae6c5d1b482992c7878b4be3174f (diff)
parentb38ef579fb75c777fac2eef3d4bcda2c97014f0b (diff)
downloaddexon-sol-tools-9ffddb47b8c9187401c1df6e5d5953caad3a9274.tar
dexon-sol-tools-9ffddb47b8c9187401c1df6e5d5953caad3a9274.tar.gz
dexon-sol-tools-9ffddb47b8c9187401c1df6e5d5953caad3a9274.tar.bz2
dexon-sol-tools-9ffddb47b8c9187401c1df6e5d5953caad3a9274.tar.lz
dexon-sol-tools-9ffddb47b8c9187401c1df6e5d5953caad3a9274.tar.xz
dexon-sol-tools-9ffddb47b8c9187401c1df6e5d5953caad3a9274.tar.zst
dexon-sol-tools-9ffddb47b8c9187401c1df6e5d5953caad3a9274.zip
Merge branch 'development' of https://github.com/0xProject/0x-monorepo into sra-api/rename/sra-spec
Diffstat (limited to 'packages/forwarder-helper/README.md')
-rw-r--r--packages/forwarder-helper/README.md83
1 files changed, 83 insertions, 0 deletions
diff --git a/packages/forwarder-helper/README.md b/packages/forwarder-helper/README.md
new file mode 100644
index 000000000..c74526910
--- /dev/null
+++ b/packages/forwarder-helper/README.md
@@ -0,0 +1,83 @@
+## @0xproject/forwarder-helper
+
+Provides convenience objects to help work with the Forwarder Contract
+
+### Read the [Documentation](https://0xproject.com/docs/forwarder-helper).
+
+## Installation
+
+```bash
+yarn add @0xproject/forwarder-helper
+```
+
+**Import**
+
+```typescript
+import { forwarderHelperFactory } from '@0xproject/forwarder-helper';
+```
+
+or
+
+```javascript
+var forwarderHelperFactory = require('@0xproject/forwarder-helper').forwarderHelperFactory;
+```
+
+If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
+
+```json
+"compilerOptions": {
+ "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
+}
+```
+
+## 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/forwarder-helper yarn build
+```
+
+Or continuously rebuild on change:
+
+```bash
+PKG=@0xproject/forwarder-helper yarn watch
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Run Tests
+
+```bash
+yarn test
+```