aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-07-06 19:10:00 +0800
committerGitHub <noreply@github.com>2018-07-06 19:10:00 +0800
commit8eefc89d550644495de30123b9a2bf22006a74ed (patch)
treebbd3693f4963453a8f0f1feb370e51271be0e234
parent20d349cea71dd98001da18a1cf81e1c5a1844aaa (diff)
parent22f408f713961a0684ef947a4c71811fde409d2c (diff)
downloaddexon-sol-tools-8eefc89d550644495de30123b9a2bf22006a74ed.tar
dexon-sol-tools-8eefc89d550644495de30123b9a2bf22006a74ed.tar.gz
dexon-sol-tools-8eefc89d550644495de30123b9a2bf22006a74ed.tar.bz2
dexon-sol-tools-8eefc89d550644495de30123b9a2bf22006a74ed.tar.lz
dexon-sol-tools-8eefc89d550644495de30123b9a2bf22006a74ed.tar.xz
dexon-sol-tools-8eefc89d550644495de30123b9a2bf22006a74ed.tar.zst
dexon-sol-tools-8eefc89d550644495de30123b9a2bf22006a74ed.zip
Merge pull request #831 from 0xProject/fix-readme-intros
Update Package Descriptions
-rw-r--r--packages/sol-compiler/README.md8
-rw-r--r--packages/web3-wrapper/README.md2
-rw-r--r--packages/website/md/docs/sol-compiler/introduction.md21
-rw-r--r--packages/website/md/docs/web3_wrapper/introduction.md2
4 files changed, 17 insertions, 16 deletions
diff --git a/packages/sol-compiler/README.md b/packages/sol-compiler/README.md
index 76d0e9b8b..3a6ca130b 100644
--- a/packages/sol-compiler/README.md
+++ b/packages/sol-compiler/README.md
@@ -1,6 +1,12 @@
## @0xproject/sol-compiler
-This repository contains a CLI tool that facilitates compiling smart contracts.
+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).
### Read the [Documentation](https://0xproject.com/docs/sol-compiler).
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md
index bfa98deff..06c788101 100644
--- a/packages/web3-wrapper/README.md
+++ b/packages/web3-wrapper/README.md
@@ -1,6 +1,6 @@
## @0xproject/web3-wrapper
-Wrapped version of web3 with a nicer interface that is used across 0x projects and packages.
+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.
### Read the [Documentation](https://0xproject.com/docs/web3-wrapper).
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.