diff --git a/README.md b/README.md index 3587bc1..16298bd 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) +## Install: +``` +$ 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