From 092e35bae31d339f57374a21f6d1443124b2369b Mon Sep 17 00:00:00 2001 From: David Sun Date: Mon, 15 Jul 2019 14:17:41 -0700 Subject: [PATCH] updated README.md --- README.md | 1 + packages/asset-swapper/README.md | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c080b63c2..00099e4c27 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,7 @@ These packages are all under development. See [/contracts/README.md](/contracts/ | [`@0x/sra-spec`](/packages/sra-spec) | [![npm](https://img.shields.io/npm/v/@0x/sra-spec.svg)](https://www.npmjs.com/package/@0x/sra-spec) | OpenAPI specification for the Standard Relayer API | | [`@0x/connect`](/packages/connect) | [![npm](https://img.shields.io/npm/v/@0x/connect.svg)](https://www.npmjs.com/package/@0x/connect) | An HTTP/WS client for interacting with the Standard Relayer API | | [`@0x/asset-buyer`](/packages/asset-buyer) | [![npm](https://img.shields.io/npm/v/@0x/asset-buyer.svg)](https://www.npmjs.com/package/@0x/asset-buyer) | Convenience package for discovering and buying assets with Ether | +| [`@0x/asset-swapper`](/packages/asset-swapper) | [![npm](https://img.shields.io/npm/v/@0x/asset-swapper.svg)](https://www.npmjs.com/package/@0x/asset-swapper) | Convenience package for discovering and performing swaps for any ERC20 Assets | #### Ethereum tooling diff --git a/packages/asset-swapper/README.md b/packages/asset-swapper/README.md index 8c5171f4c4..e6c88131a0 100644 --- a/packages/asset-swapper/README.md +++ b/packages/asset-swapper/README.md @@ -1,6 +1,8 @@ ## @0x/asset-swapper -Convenience package for buying assets represented on the Ethereum blockchain using 0x. +Convenience package for swapping assets represented on the Ethereum blockchain using 0x. The package helps to perform all the off-chain computations to execute a marketBuy or marketSell function execution with 0x exchange contracts, or 0x extension contracts. Given some liquidity (0x signed orders), it helps estimate the cost of buying or selling a certain asset (giving a range) and then provide varying consumable outputs to execute the buy or sell. + +Asset-swapper integrates with the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api)(in the future Mesh as well) and takes care of sourcing liquidity, order-pruning, and order-validation. The final result is a library that tells you what assets are available, provides a quote based on specified assets, and provide varying consumable metadata that can be used both on-chain in smart contracts or off-chain through web3 to swap a desired amount of ERC20 for another ERC20 asset. ## Installation