Skip to content

Commit 0885e1f

Browse files
committed
docs: minor grammar fixes
1 parent 412a4d3 commit 0885e1f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
# Swap SDK
44

5-
The missing peer-to-peer swap library for Ethereum and EVM compatible chains, powered by the [0x protocol](https://0x.org), written in TypeScript for web3 developers. Trade tokens (ERC20s), NFTs, and other collectibles (ERC721 and ERC1155) with just a few lines of code. Seriously, easily trade anything on Ethereum with this library.
5+
The missing peer-to-peer swap library for Ethereum and EVM-compatible chains, powered by the [0x protocol](https://0x.org), written in TypeScript for web3 developers. Trade tokens (ERC20s), NFTs, and other collectibles (ERC721 and ERC1155) with just a few lines of code. Seriously, easily trade anything on Ethereum with this library.
66

77
**🎉 Update 1/31/22: Swap SDK now supports 0x v4, check out the [docs](https://docs.swapsdk.xyz/0x-v4). 🎉**
88

99
## Overview
1010

11-
tl;dr: NFT Swap SDK is the easiest, most-powerful swap library available on the EVM. Supports Ethereum and EVM-compatible chains (Polygon, Avalanche, BSC, etc..). Works in both browser and node.js. Written in TypeScript, built using the 0x protocol. With this library, you can build support for NFT marketplaces, over-the-counter (OTC) exchange, and/or peer-to-peer exchange.
11+
tl;dr: NFT Swap SDK is the easiest, most-powerful swap library available on the EVM. Supports Ethereum and EVM-compatible chains (Polygon, Avalanche, BSC, etc.). Works in both browser and Node.js. Written in TypeScript, built using the 0x protocol. With this library, you can build support for NFT marketplaces, over-the-counter (OTC) exchanges, and/or peer-to-peer exchanges.
1212

1313
The NFT Swap SDK developed by [Trader.xyz](https://trader.xyz) offers swap support for ERC20s, ERC721s, and ERC1155s. Exchange NFTs for NFTs, NFTs for ERC20 tokens, or bundles of NFTs and tokens. This library provides the ultimate swap flexibility combined with a simple API surface area so you can be productive immediately and focus on building your web3 app.
1414

@@ -41,7 +41,7 @@ import { NftSwap } from '@traderxyz/nft-swap-sdk';
4141
const nftSwapSdk = new NftSwap(provider, signer, chainId);
4242
```
4343

44-
Now you're setup and ready to use the SDK in your program. Check out the examples for how to swap with the library.
44+
Now you're set up and ready to use the SDK in your program. Check out the examples below to learn how to swap with the library.
4545

4646
## Examples
4747

@@ -153,7 +153,7 @@ More concrete example: We can swap `[2 CryptoPunks and 1,000 DAI] for [420 WETH
153153
This is just one example. In reality, you can swap as many things as you'd like, any way you'd like. The underlying 0x protocol is extremely flexible, and the NFT swap library abstracts all the complexity away so you don't have to worry about protocol nuances.
154154

155155
```tsx
156-
// Setup the sample data for the swap...
156+
// Set up the sample data for the swap...
157157
const CHAIN_ID = 1; // Mainnet
158158

159159
const CRYPTOPUNK_420 = {
@@ -248,7 +248,7 @@ const App = () => {
248248

249249
## FAQ
250250

251-
- Which ERCs does this library support
251+
- Which ERCs does this library support?
252252

253253
- ERC20, ERC721, and ERC1155
254254

@@ -261,7 +261,7 @@ const App = () => {
261261
- Binance Smart Chain (56)
262262
- Avalanche (43114)
263263

264-
- What protocol does this library?
264+
- What protocol does this library use?
265265

266266
- trader.xyz and trader.xyz libraries are powered by 0x v3 Protocol. This protocol is mature and lindy, and has been extremely well-audited.
267267
- Check out the 0x v3 spec [here](https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md)
@@ -290,13 +290,13 @@ For general documentation, check out https://docs.swapsdk.xyz
290290

291291
## Roadmap
292292

293-
We're currently working on the following features for the next iteration of this library
293+
We're currently working on the following features for the next iteration of this library:
294294

295295
- ✅ LIVE -- Persistent data store of orders (off-the-shelf storage in trader.xyz's public order storage server). Think of it as a public good
296296
- ✅ LIVE -- Property-based orders
297297
- ✅ LIVE -- Order validation
298298
- ✅ LIVE -- Live order status
299-
- Order event streaming via websockets
299+
- Order event streaming via WebSockets
300300

301301
If you have feature requests, reach out in our [Discord](https://discord.gg/GCf5rSX6).
302302

0 commit comments

Comments
 (0)