diff options
| author | fragosti <francesco.agosti93@gmail.com> | 2018-09-20 20:09:11 +0800 |
|---|---|---|
| committer | fragosti <francesco.agosti93@gmail.com> | 2018-09-20 20:09:11 +0800 |
| commit | 3238925aa4e13750e5a8e45b3130ce9e148efae8 (patch) | |
| tree | 8da4a0a50343513633514cf448b2d69487a02529 /packages/asset-buyer/README.md | |
| parent | a44f77a83811146ad68ee6f56bcda94e56d6a634 (diff) | |
| download | dexon-0x-contracts-3238925aa4e13750e5a8e45b3130ce9e148efae8.tar.gz dexon-0x-contracts-3238925aa4e13750e5a8e45b3130ce9e148efae8.tar.zst dexon-0x-contracts-3238925aa4e13750e5a8e45b3130ce9e148efae8.zip | |
Add better description to README
Diffstat (limited to 'packages/asset-buyer/README.md')
| -rw-r--r-- | packages/asset-buyer/README.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/packages/asset-buyer/README.md b/packages/asset-buyer/README.md index 717849bf2..f615b93e1 100644 --- a/packages/asset-buyer/README.md +++ b/packages/asset-buyer/README.md @@ -1,6 +1,8 @@ ## @0xproject/asset-buyer -Convenience package for buying assets +Convenience package for buying assets represented on the Ethereum blockchain using 0x. In its simplest form, the package helps in the usage of the [0x forwarder contract](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/forwarder-specification.md), which allows users to execute Wrapped Ether based 0x orders without having to set allowances, wrap Ether or buy ZRX, meaning they can buy tokens with Ether alone. Given some liquidity (0x signed orders), it helps estimate the Ether cost of buying a certain asset (giving a range) and then buying that asset. + +In its more advanced and useful form, it integrates with the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) and takes care of sourcing liquidity for you given an SRA compliant endpoint. The final result is a library that tells you what assets are available, provides an Ether based quote for any asset desired, and allows you to buy that asset using Ether alone. ### Read the [Documentation](https://0xproject.com/docs/asset-buyer). |