diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-07-06 19:05:13 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-07-06 19:05:13 +0800 |
| commit | 22f408f713961a0684ef947a4c71811fde409d2c (patch) | |
| tree | d8aab2e5728d8c07d3cd52d9a650d791edd89fd6 /packages/website/md | |
| parent | e0f80c5e6aea48e83108d6c6cd481cdce26c9a4a (diff) | |
| download | dexon-sol-tools-22f408f713961a0684ef947a4c71811fde409d2c.tar dexon-sol-tools-22f408f713961a0684ef947a4c71811fde409d2c.tar.gz dexon-sol-tools-22f408f713961a0684ef947a4c71811fde409d2c.tar.bz2 dexon-sol-tools-22f408f713961a0684ef947a4c71811fde409d2c.tar.lz dexon-sol-tools-22f408f713961a0684ef947a4c71811fde409d2c.tar.xz dexon-sol-tools-22f408f713961a0684ef947a4c71811fde409d2c.tar.zst dexon-sol-tools-22f408f713961a0684ef947a4c71811fde409d2c.zip | |
Update readme and doc intros
Diffstat (limited to 'packages/website/md')
| -rw-r--r-- | packages/website/md/docs/sol-compiler/introduction.md | 21 | ||||
| -rw-r--r-- | packages/website/md/docs/web3_wrapper/introduction.md | 2 |
2 files changed, 9 insertions, 14 deletions
diff --git a/packages/website/md/docs/sol-compiler/introduction.md b/packages/website/md/docs/sol-compiler/introduction.md index aa1939006..fcd80f47b 100644 --- a/packages/website/md/docs/sol-compiler/introduction.md +++ b/packages/website/md/docs/sol-compiler/introduction.md @@ -1,13 +1,8 @@ -Welcome to the [sol-compiler](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-compiler) documentation! Sol-compiler is a tool for compiling Solidity smart contracts and generating artifacts with ease. - -It serves a similar purpose as parts of the [Truffle framework](http://truffleframework.com/), but with the UNIX philosophy in mind: Make each program do one thing well. This tool is for intermediate to advanced Solidity developers that require greater configurability and reliability. - -Sol-compiler has the following advantages over Truffle: - -* Compile each smart contract with a specific version of Solidity. -* Improved artifact files: - * Storage of constructor args, source maps and paths to all requisite source files. - * An easy to maintain codebase: TypeScript + Single repo. - * Supports Solidity version ranges - contract compiled with latest Solidity version that satisfies the range. - -Sol-compiler can be used as a command-line tool or as an imported module. +Welcome to the [sol-compiler](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-compiler) documentation! Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) that adds: + +* Smart re-compilation: Only recompiles when smart contracts have changed +* Ability to compile an entire project instead of only individual `.sol` files +* Compilation using the Solidity version specified at the top of each individual `.sol` file +* Proper parsing of Solidity version ranges +* Support for the standard [input description](https://solidity.readthedocs.io/en/develop/using-the-compiler.html#input-description) for what information you'd like added to the resulting `artifacts` file (i.e 100% configurable artifacts content). +* Storage of constructor args, source maps and paths to all dependency source files. diff --git a/packages/website/md/docs/web3_wrapper/introduction.md b/packages/website/md/docs/web3_wrapper/introduction.md index ea2f4cf0d..17bd316f1 100644 --- a/packages/website/md/docs/web3_wrapper/introduction.md +++ b/packages/website/md/docs/web3_wrapper/introduction.md @@ -1 +1 @@ -Welcome to the [Web3Wrapper](https://github.com/0xProject/0x-monorepo/tree/development/packages/web3-wrapper) documentation! Web3Wrapper is a convenience library that wraps Web3 v0.x, providing promise-based endpoints and a consistent API. +Welcome to the [Web3Wrapper](https://github.com/0xProject/0x-monorepo/tree/development/packages/web3-wrapper) documentation! Web3-wrapper is a JSON-RPC client for Ethereum nodes. It is a type-safe alternative to [Web3.js](https://github.com/ethereum/web3.js/) written in TypeScript. |