Update readmes for connect, kovan-facuets, types, and utils packages

This commit is contained in:
Brandon Millman
2017-12-19 12:55:48 -05:00
parent 1316a2dd2a
commit ca2bb60877
4 changed files with 181 additions and 18 deletions

View File

@@ -1 +1,51 @@
@0xproject/connect
------
This repository contains a Javascript library that makes it easy to interact with Relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) This repository contains a Javascript library that makes it easy to interact with Relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api)
## Installation
```bash
yarn add @0xproject/connect
```
## Usage
* [Docs](https://0xproject.com/docs/connect)
* [Tutorials](https://0xproject.com/wiki#connect)
## Contributing
We strongly encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
[CONTRIBUTING.md](../../CONTRIBUTING.md)
### Install Dependencies
If you don't have yarn workspaces enabled - enable them:
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
```bash
yarn install
```
### Build
```bash
yarn build
```
### Lint
```bash
yarn lint
```
### Run Tests
```bash
yarn test
```

View File

@@ -1,22 +1,35 @@
Test Ether Faucet @0xproject/kovan_faucets
---------------------- ------
This faucet dispenses 0.1 test ether to one recipient per second. It has a max queue size of 1000. This faucet dispenses 0.1 test ether to one recipient per second. It has a max queue size of 1000.
## Installation
## Install This is a private package and therefore is not published to npm. In order to build and run this package locally, see the [Install Dependencies](#Install-Dependencies) section and onwards below.
Install project dependencies: ## Contributing
``` We strongly encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
npm install
[CONTRIBUTING.md](../../CONTRIBUTING.md)
### Install Dependencies
If you don't have yarn workspaces enabled - enable them:
```bash
yarn config set workspaces-experimental true
``` ```
## Start Then install dependencies
```bash
yarn install
```
### Start
Set the following environment variables: Set the following environment variables:
``` ```bash
export FAUCET_ENVIRONMENT=development export FAUCET_ENVIRONMENT=development
export DISPENSER_ADDRESS=0x5409ed021d9299bf6814279a6a1411a7e866a631 export DISPENSER_ADDRESS=0x5409ed021d9299bf6814279a6a1411a7e866a631
export DISPENSER_PRIVATE_KEY=f2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257d export DISPENSER_PRIVATE_KEY=f2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257d
@@ -28,11 +41,11 @@ Infura API Key can be requested here: https://infura.io/register.html
Note: The above public/private keys exist when running `testrpc` with the following option `--mnemonic concert load couple harbor equip island argue ramp clarify fence smart topic`. Note: The above public/private keys exist when running `testrpc` with the following option `--mnemonic concert load couple harbor equip island argue ramp clarify fence smart topic`.
``` ```bash
npm run dev yarn dev
``` ```
## Endpoints ### Endpoints
```GET /ether/:recipient``` ```GET /ether/:recipient```
@@ -42,7 +55,6 @@ Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
Where recipient_address is a hex encoded Ethereum address prefixed with `0x`. Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
```javascript ```javascript
{ {
"full": false, "full": false,
@@ -50,7 +62,7 @@ Where recipient_address is a hex encoded Ethereum address prefixed with `0x`.
} }
``` ```
## Docker configs ### Docker configs
``` ```
docker run -d \ docker run -d \
@@ -64,3 +76,13 @@ docker run -d \
-e FAUCET_ENVIRONMENT=production \ -e FAUCET_ENVIRONMENT=production \
kovan-faucets kovan-faucets
``` ```
### Lint
```bash
yarn lint
```
### Run Tests
N/A

View File

@@ -1,10 +1,55 @@
0x types @0xproject/types
------ ------
TS types shared across 0x projects and packages Typescript types shared across 0x projects and packages
## Install ## Installation
```bash ```bash
yarn add -D @0xproject/types yarn add -D @0xproject/types
``` ```
## Usage
```javascript
import {
TransactionReceipt,
TxData,
TxDataPayable,
} from '@0xproject/types';
```
## Contributing
We strongly encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
[CONTRIBUTING.md](../../CONTRIBUTING.md)
### Install Dependencies
If you don't have yarn workspaces enabled - enable them:
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
```bash
yarn install
```
### Build
```bash
yarn build
```
### Lint
```bash
yarn lint
```
### Run Tests
N/A

View File

@@ -1,10 +1,56 @@
utils @0xproject/utils
------ ------
Utils to be shared across 0x projects and packages Utils to be shared across 0x projects and packages
## Install ## Installation
```bash ```bash
yarn add @0xproject/utils yarn add @0xproject/utils
``` ```
## Usage
```javascript
import {
addressUtils,
bigNumberConfigs,
classUtils,
intervalUtils,
promisify,
} from '@0xproject/utils';
```
## Contributing
We strongly encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
[CONTRIBUTING.md](../../CONTRIBUTING.md)
### Install Dependencies
If you don't have yarn workspaces enabled - enable them:
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
```bash
yarn install
```
### Build
```bash
yarn build
```
### Lint
```bash
yarn lint
```
### Run Tests
N/A