aboutsummaryrefslogtreecommitdiffstats
path: root/packages/forwarder-helper/README.md
diff options
context:
space:
mode:
authorF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-09-25 01:30:37 +0800
committerF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-09-25 01:30:37 +0800
commit2116548eed666c3c61277f17e996fee720301f31 (patch)
tree6f4b601b59659ac9134ffe4efed79c8a8a2750e0 /packages/forwarder-helper/README.md
parent57fca16d7b1dc61c060c90fa440b1dc947aefb93 (diff)
parentb830c28d83a33c0170d4f150ee287ea97ccf7865 (diff)
downloaddexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.gz
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.bz2
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.lz
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.xz
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.tar.zst
dexon-sol-tools-2116548eed666c3c61277f17e996fee720301f31.zip
Merge remote-tracking branch 'upstream/development' into sol-doc
Diffstat (limited to 'packages/forwarder-helper/README.md')
-rw-r--r--packages/forwarder-helper/README.md83
1 files changed, 0 insertions, 83 deletions
diff --git a/packages/forwarder-helper/README.md b/packages/forwarder-helper/README.md
deleted file mode 100644
index c74526910..000000000
--- a/packages/forwarder-helper/README.md
+++ /dev/null
@@ -1,83 +0,0 @@
-## @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
-```