Update readme, changelog, and package.json with rename

This commit is contained in:
Brandon Millman
2018-09-14 13:54:06 +02:00
parent 91702bbae2
commit 8da7d39998
4 changed files with 14 additions and 51 deletions

View File

@@ -1,30 +1,10 @@
[
{
"timestamp": 1536142250,
"version": "1.0.1",
"version": "1.0.0-rc.1",
"changes": [
{
"note": "Dependencies updated"
"note": "Init"
}
]
},
{
"version": "1.0.1-rc.2",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1535377027
},
{
"version": "1.0.1-rc.1",
"changes": [
{
"note": "Add initial forwarderHelperFactory",
"pr": 997
}
],
"timestamp": 1535133899
}
]

View File

@@ -1,18 +1 @@
<!--
changelogUtils.file is auto-generated using the monorepo-scripts package. Don't edit directly.
Edit the package's CHANGELOG.json file only.
-->
CHANGELOG
## v1.0.1 - _September 5, 2018_
* Dependencies updated
## v1.0.1-rc.2 - _August 27, 2018_
* Dependencies updated
## v1.0.1-rc.1 - _August 24, 2018_
* Add initial forwarderHelperFactory (#997)

View File

@@ -1,25 +1,25 @@
## @0xproject/forwarder-helper
## @0xproject/asset-buyer
Provides convenience objects to help work with the Forwarder Contract
Convenience package for buying assets
### Read the [Documentation](https://0xproject.com/docs/forwarder-helper).
### Read the [Documentation](https://0xproject.com/docs/asset-buyer).
## Installation
```bash
yarn add @0xproject/forwarder-helper
yarn add @0xproject/asset-buyer
```
**Import**
```typescript
import { forwarderHelperFactory } from '@0xproject/forwarder-helper';
import { AssetBuyer } from '@0xproject/asset-buyer';
```
or
```javascript
var forwarderHelperFactory = require('@0xproject/forwarder-helper').forwarderHelperFactory;
var AssetBuyer = require('@0xproject/asset-buyer').AssetBuyer;
```
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
@@ -55,13 +55,13 @@ yarn install
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
PKG=@0xproject/asset-buyer yarn build
```
Or continuously rebuild on change:
```bash
PKG=@0xproject/forwarder-helper yarn watch
PKG=@0xproject/asset-buyer yarn watch
```
### Clean

View File

@@ -1,10 +1,10 @@
{
"name": "@0xproject/forwarder-helper",
"version": "1.0.1",
"name": "@0xproject/asset-buyer",
"version": "1.0.0-rc.1",
"engines": {
"node": ">=6.12"
},
"description": "Convenience object for working with the forwarder contract",
"description": "Convenience package for buying assets",
"main": "lib/src/index.js",
"types": "lib/src/index.d.ts",
"scripts": {
@@ -37,7 +37,7 @@
"bugs": {
"url": "https://github.com/0xProject/0x-monorepo/issues"
},
"homepage": "https://github.com/0xProject/0x-monorepo/packages/forwarder-helper/README.md",
"homepage": "https://github.com/0xProject/0x-monorepo/packages/asset-buyer/README.md",
"dependencies": {
"@0xproject/assert": "^1.0.8",
"@0xproject/connect": "^2.0.0",