From 8da7d399981472ff9cbfa28fb0957a530de72b2d Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Fri, 14 Sep 2018 13:54:06 +0200 Subject: Update readme, changelog, and package.json with rename --- packages/asset-buyer/CHANGELOG.json | 24 ++---------------------- packages/asset-buyer/CHANGELOG.md | 17 ----------------- packages/asset-buyer/README.md | 16 ++++++++-------- packages/asset-buyer/package.json | 8 ++++---- 4 files changed, 14 insertions(+), 51 deletions(-) diff --git a/packages/asset-buyer/CHANGELOG.json b/packages/asset-buyer/CHANGELOG.json index f0e646700..2e4db1f6e 100644 --- a/packages/asset-buyer/CHANGELOG.json +++ b/packages/asset-buyer/CHANGELOG.json @@ -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 } ] diff --git a/packages/asset-buyer/CHANGELOG.md b/packages/asset-buyer/CHANGELOG.md index d6b67aa1b..8b1378917 100644 --- a/packages/asset-buyer/CHANGELOG.md +++ b/packages/asset-buyer/CHANGELOG.md @@ -1,18 +1 @@ - -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) diff --git a/packages/asset-buyer/README.md b/packages/asset-buyer/README.md index c74526910..717849bf2 100644 --- a/packages/asset-buyer/README.md +++ b/packages/asset-buyer/README.md @@ -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 diff --git a/packages/asset-buyer/package.json b/packages/asset-buyer/package.json index f849fb4ed..e4d3d0701 100644 --- a/packages/asset-buyer/package.json +++ b/packages/asset-buyer/package.json @@ -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", -- cgit v1.2.3