chore(readme): improve readme

This commit is contained in:
Jonathan Rainville 2018-11-15 12:02:19 -05:00
parent 2e4022a38d
commit e9c2b0dce6
1 changed files with 6 additions and 6 deletions

View File

@ -3,13 +3,14 @@ Embark-Solc
Plugin for [Embark](https://github.com/embark-framework/embark) to compile contracts using solc
Installation
======
## Installation
In your embark dapp directory:
```npm install embark-solc --save```
then add embark-solc to the plugins section in ```embark.json```:
then add embark-solc to the plugins section in `embark.json`:
```Json
"plugins": {
@ -21,9 +22,8 @@ then add embark-solc to the plugins section in ```embark.json```:
- `outputBinary` can be specified to generate a .bin file that contains the binary of the contracts in hex. Default value is `false`.
Requirements
======
## Requirements
- Embark 3.0.0 or higher
- Solc installed and available globally on your machine
- [Solc](https://github.com/ethereum/solidity/releases) installed and available globally on your machine (h)