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

Clarify how to include these libraries #62

Open
wants to merge 1 commit 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
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,36 @@ Below are all crates provided by the etcommon project.
As `etcommon` will be depended on many other projects like SputnikVM and EASM, rolling release is necessary to keep up with the development speed.

Note that rolling release will only happen for sub-crates like `etcommon-bigint`, `etcommon-rlp`, `etcommon-util`, etc. The top-level crate `etcommon` will follow the normal release process.

## Usage
The repositories on crates.io are labeled with the prefix `etcommon-`, however the crates themselves do not have this prefix so you'll need to specify them as `etcommon-PACKAGE = "^0"` in `Cargo.toml` and as `extern crate PACKAGE;` in your `main.rs`

### etcommon-rlp
Cargo.toml: `etcommon-rlp = "^0"`

main.rs: `extern crate rlp;`

### etcommon-bigint
Cargo.toml: `etcommon-bigint = "^0"`

main.rs: `extern crate bigint;`

### etcommon-hexutil
Cargo.toml: `etcommon-hexutil = "^0"`

main.rs: `extern crate hexutil;`

### etcommon-trie
Cargo.toml: `etcommon-trie = "^0"`

main.rs: `extern crate trie;`

### etcommon-block
Cargo.toml: `etcommon-block = "^0"`

main.rs: `extern crate block;`

### etcommon-block-core
Cargo.toml: `etcommon-block-core = "^0"`

main.rs: `extern crate block_core;`