More accurate description of the repo

This commit is contained in:
Niklas Adofsson 2018-09-02 20:45:45 +02:00
parent b2c37911ff
commit 2f459c34fa
1 changed files with 15 additions and 4 deletions

View File

@ -1,21 +1,25 @@
# bigint
# Ethereum primitives
[![Build Status](https://travis-ci.org/paritytech/primitives.svg?branch=master)](https://travis-ci.org/paritytech/primitives)
Fixed-sized integers arithmetic
Fixed-sized integer arithmetic (ethereum-types) and bloom filter (ethbloom)
To specify a dependency, add to `Cargo.toml`
To add this crate to your project, add the following in `Cargo.toml`
```toml
[dependencies]
ethereum-types = "0.4"
ethbloom = "0.5"
```
Little example
A basic example how to use this crate:
```rust
extern crate ethereum_types;
extern crate ethbloom;
use ethereum_types::U256;
use ethbloom::{Bloom, Input};
fn main() {
let mut val: U256 = 1023.into();
@ -24,7 +28,13 @@ fn main() {
&format!("{}", val),
"1643897619276947051879427220465009342380213662639797070513307648"
);
let address = [0_u8; 32];
let mut my_bloom = Bloom::default();
assert!(!my_bloom.contains_input(Input::Raw(&address)));
my_bloom.accrue(Input::Raw(&address));
}
```
### `no_std` crates
@ -35,4 +45,5 @@ in a `no_std` context, add the following to your `Cargo.toml`:
```toml
[dependencies]
ethereum-types = { version = "0.4", default-features = false }
ethbloom = { version = "0.5", default-features = false }
```