diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-07-20 02:45:00 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-07-20 02:45:00 +0800 |
| commit | b72857cd8b8a391b340d2f09636b140bcfd73a31 (patch) | |
| tree | 887a9bd1e7f269843c6abb095f33da96208e52c4 /packages/website/md/docs | |
| parent | cc223b9eaba4710767227644d2db63298a6b8ecb (diff) | |
| download | dexon-sol-tools-b72857cd8b8a391b340d2f09636b140bcfd73a31.tar dexon-sol-tools-b72857cd8b8a391b340d2f09636b140bcfd73a31.tar.gz dexon-sol-tools-b72857cd8b8a391b340d2f09636b140bcfd73a31.tar.bz2 dexon-sol-tools-b72857cd8b8a391b340d2f09636b140bcfd73a31.tar.lz dexon-sol-tools-b72857cd8b8a391b340d2f09636b140bcfd73a31.tar.xz dexon-sol-tools-b72857cd8b8a391b340d2f09636b140bcfd73a31.tar.zst dexon-sol-tools-b72857cd8b8a391b340d2f09636b140bcfd73a31.zip | |
Update doc md files for v2 packages
Diffstat (limited to 'packages/website/md/docs')
| -rw-r--r-- | packages/website/md/docs/0xjs/2.0.0/introduction.md | 3 | ||||
| -rw-r--r-- | packages/website/md/docs/0xjs/2.0.0/versioning.md | 1 | ||||
| -rw-r--r-- | packages/website/md/docs/json_schemas/1.0.0/introduction.md | 2 |
3 files changed, 6 insertions, 0 deletions
diff --git a/packages/website/md/docs/0xjs/2.0.0/introduction.md b/packages/website/md/docs/0xjs/2.0.0/introduction.md new file mode 100644 index 000000000..b98aeef38 --- /dev/null +++ b/packages/website/md/docs/0xjs/2.0.0/introduction.md @@ -0,0 +1,3 @@ +<b>**NOTE:** Release candidate versions are meant to work with V2 of 0x protocol. To interact with V1, select a 0.X version.</b> + +Welcome to the [0x.js](https://github.com/0xProject/0x-monorepo) documentation! 0x.js is a Javascript library for interacting with the 0x protocol. With it, you can easily make calls to the 0x smart contracts as well as any token adhering to the token standards supported by the protocol (currently ERC20 & ERC721). Functionality includes generating, signing, filling and cancelling orders, verifying an orders signature, setting or checking a users ERC20/ERC721 token balance/allowance and much more. diff --git a/packages/website/md/docs/0xjs/2.0.0/versioning.md b/packages/website/md/docs/0xjs/2.0.0/versioning.md new file mode 100644 index 000000000..5fe66ad9a --- /dev/null +++ b/packages/website/md/docs/0xjs/2.0.0/versioning.md @@ -0,0 +1 @@ +Since v1.0, this package adheres to the [Semantic Versioning 2.0.0](http://semver.org/) specification. The library's public interface includes all the methods, properties and types included in the documentation. We will publish with a major version bump for any breaking change to the public interface, use a minor version bump when introducing new features in a backwards-compatible way, and patch versions when introducing backwards-compatible bug fixes. Because of this, we recommend you import `0x.js` with a caret `^2.0.0` to take advantage of non-breaking bug fixes. diff --git a/packages/website/md/docs/json_schemas/1.0.0/introduction.md b/packages/website/md/docs/json_schemas/1.0.0/introduction.md index a27f4b521..cc777b1a8 100644 --- a/packages/website/md/docs/json_schemas/1.0.0/introduction.md +++ b/packages/website/md/docs/json_schemas/1.0.0/introduction.md @@ -1,3 +1,5 @@ +<b>**NOTE:** Release candidate versions are meant to work with V2 of 0x protocol. To interact with V1, select a 0.X version.</b> + Welcome to the [@0xproject/json-schemas](https://github.com/0xProject/0x-monorepo/tree/development/packages/json-schemas) documentation! This package provides JSON schemas for validating 0x Protocol & Standard Relayer API data structures. It provides both the raw JSON schemas and a schema validator class to interact with them from a JS project. If you are not using a Javascript-based language for your project, you can copy-paste the JSON schemas within this package and use them together with a [JSON Schema](http://json-schema.org/) implementation in your [language of choice](http://json-schema.org/implementations.html) (e.g Python, Haskell, Go, C, C++, Rust, Ruby, Scala, etc...). |