From 3f8ce0d19b89cd8cc7a013039d5ac4e415ee3f0f Mon Sep 17 00:00:00 2001 From: Stevan Lohja Date: Wed, 31 Oct 2018 15:49:51 -0500 Subject: [PATCH 1/3] Updated README.md Updated readme file with more information. --- README.md | 46 +++++++++++++++++++++++++++++++--------------- 1 file changed, 31 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3587bc1..1f48732 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ -# Emerald Framework +# Emerald CLI +Emerald CLI encapsulates all the best Emerald tools with smart contract testing and deployment capabilities. -### Installation: +## [Emerald CLI Documentation](https://docs.etcdevteam.com/emerald-platform/emerald) -``` -npm install -g https://github.com/ETCDEVTeam/emerald.git -``` +## Dependencies + +- [nodenv](https://github.com/nodenv/nodenv) +- [node-build](https://github.com/nodenv/node-build#readme) +## Installation: +``` +$ npm install -g https://github.com/ETCDEVTeam/emerald.git +``` -### Usage: +## Usage: ``` USAGE @@ -18,18 +24,28 @@ npm install -g https://github.com/ETCDEVTeam/emerald.git COMMANDS - new Create a new project - wallet Boot Emerald Wallet - explorer Boot Explorer - testrpc Run testnet for ethereum classic - deploy Deploy solidity to network - help Display help for a specific command + new Create a new project + vault Run emerald vault + testrpc [passphrase] Run testnet for ethereum classic + wallet Boot Emerald Wallet + explorer Boot Explorer + compile Compile solidity for ethereum classic + deploy Deploy solidity to network + help Display help for a specific command GLOBAL OPTIONS - -h, --help Display help - -V, --version Display version - --no-color Disable colors + -h, --help Display help + -V, --version Display version + --no-color Disable colors --quiet Quiet mode - only displays warn and error messages -v, --verbose Verbose mode - will also output debug messages ``` + +## Chat + +We welcome new and existing developers to chat with us and other developer community members on [Gitter](https://gitter.im/etcdev-public/). + +## License + +Apache 2.0 From d064bc51e789c207ef95fdb0335f928567098099 Mon Sep 17 00:00:00 2001 From: Stevan Lohja Date: Wed, 31 Oct 2018 15:54:15 -0500 Subject: [PATCH 2/3] Update README.md Updated readme file --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f48732..1b2ade5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Emerald CLI encapsulates all the best Emerald tools with smart contract testing and deployment capabilities. -## [Emerald CLI Documentation](https://docs.etcdevteam.com/emerald-platform/emerald) +### [Emerald CLI Documentation](https://docs.etcdevteam.com/emerald-platform/emerald) ## Dependencies From 11ba6006dfb29f4e614db3580fbde7c3847448ef Mon Sep 17 00:00:00 2001 From: Stevan Lohja Date: Thu, 1 Nov 2018 10:19:04 -0500 Subject: [PATCH 3/3] Updated readme and CLA requirements Updated readme and CLA requirements --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b2ade5..16298bd 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Emerald CLI encapsulates all the best Emerald tools with smart contract testing - [nodenv](https://github.com/nodenv/nodenv) - [node-build](https://github.com/nodenv/node-build#readme) -## Installation: +## Install: ``` $ npm install -g https://github.com/ETCDEVTeam/emerald.git