crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #831 from 0xProject/fix-readme-intros

Browse Source 
Update Package Descriptions
This commit is contained in:
Fabio Berger
2018-07-06 13:10:00 +02:00
committed by GitHub
parent 20d349cea7 22f408f713
commit 8eefc89d55
4 changed files with 16 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/sol-compiler/README.md
View File

@@ -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).

2
packages/web3-wrapper/README.md
View File

@@ -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).

19
packages/website/md/docs/sol-compiler/introduction.md
View File

@@ -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.
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:
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.
* 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.

2
packages/website/md/docs/web3_wrapper/introduction.md
View File

@@ -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.