aboutsummaryrefslogtreecommitdiffstats
path: root/packages/web3-wrapper/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/web3-wrapper/README.md')
-rw-r--r--packages/web3-wrapper/README.md71
1 files changed, 0 insertions, 71 deletions
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md
deleted file mode 100644
index 4402de19c..000000000
--- a/packages/web3-wrapper/README.md
+++ /dev/null
@@ -1,71 +0,0 @@
-## @0x/web3-wrapper
-
-Web3-wrapper is a JSON-RPC client for Ethereum nodes. It is a type-safe alternative to [Web3.js](https://github.com/ethereum/web3.js/) written in TypeScript.
-
-### Read the [Documentation](https://0xproject.com/docs/web3-wrapper).
-
-## Installation
-
-```bash
-yarn add @0x/web3-wrapper
-```
-
-If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
-
-```json
-"compilerOptions": {
- "typeRoots": ["node_modules/@0x/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=@0x/web3-wrapper yarn build
-```
-
-Or continuously rebuild on change:
-
-```bash
-PKG=@0x/web3-wrapper yarn watch
-```
-
-### Clean
-
-```bash
-yarn clean
-```
-
-### Lint
-
-```bash
-yarn lint
-```
-
-### Run Tests
-
-```bash
-yarn test
-```