From e9c2b0dce6c780bfe2602390f8f123aef5f6df07 Mon Sep 17 00:00:00 2001 From: Jonathan Rainville Date: Thu, 15 Nov 2018 12:02:19 -0500 Subject: [PATCH] chore(readme): improve readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4b5b0a8..271a15b 100644 --- a/README.md +++ b/README.md @@ -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)