Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pr/18 #19

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 31 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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 <command> 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 <command> 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