aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-compiler/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-07-06 19:05:13 +0800
committerFabio Berger <me@fabioberger.com>2018-07-06 19:05:13 +0800
commit22f408f713961a0684ef947a4c71811fde409d2c (patch)
treed8aab2e5728d8c07d3cd52d9a650d791edd89fd6 /packages/sol-compiler/README.md
parente0f80c5e6aea48e83108d6c6cd481cdce26c9a4a (diff)
downloaddexon-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/sol-compiler/README.md')
-rw-r--r--packages/sol-compiler/README.md8
1 files changed, 7 insertions, 1 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).