chore(readme): improve readme
This commit is contained in:
parent
2e4022a38d
commit
e9c2b0dce6
12
README.md
12
README.md
|
@ -3,13 +3,14 @@ Embark-Solc
|
||||||
|
|
||||||
Plugin for [Embark](https://github.com/embark-framework/embark) to compile contracts using solc
|
Plugin for [Embark](https://github.com/embark-framework/embark) to compile contracts using solc
|
||||||
|
|
||||||
Installation
|
## Installation
|
||||||
======
|
|
||||||
|
|
||||||
In your embark dapp directory:
|
In your embark dapp directory:
|
||||||
|
|
||||||
```npm install embark-solc --save```
|
```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
|
```Json
|
||||||
"plugins": {
|
"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`.
|
- `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
|
- 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)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue