Skip to content

Commit

Permalink
improved README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Limeth authored Jun 4, 2017
1 parent 8fb4b7a commit 0bbf825
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,22 @@
#### Custom Ethereum address generator
Get a shiny ethereum address and stand out from the crowd!

## Compilation
1. Install [Rust via Rustup.rs](http://rustup.rs/)
2. Clone this repository: `git clone https://github.com/Limeth/ethaddrgen.git; cd ethaddrgen`
3. Compile the project: `cargo build --release`
[![asciicast](https://asciinema.org/a/cmidn81zwi1c2n49ij4co9pg9.png)](https://asciinema.org/a/cmidn81zwi1c2n49ij4co9pg9)

## Features
- Regex support (`--regex`/`-e`): Use regex pattern matching
- Quiet mode (`--quiet`/`-q`): Output only the results
- Stream mode (`--stream`/`-s`): Keep outputting results
- Color settings (`--color`/`-c`): Enable/Disable colors

## Usage
The binary can be found at `target/release/ethaddrgen` or `./target/release/ethaddrgen.exe` on Windows machines.
To run it, provide a single argument -- the **regex** the resulting address should match to.
Download the latest release [here](https://github.com/Limeth/ethaddrgen/releases).
To display usage, run `ethaddrgen -h` or `ethaddrgen --help` for a longer version.
`ethaddrgen` expects the last arguments to be patterns. If no patterns are provided as arguments, `ethaddrgen` reads patterns from the standard input where each pattern is on a separate line.

For example:
* `target/release/ethaddrgen feed` will generate an address which contains the word `feed`,
* `target/release/ethaddrgen ^beef` will generate an address starting with `beef`
## Compilation
The easiest way to get ethaddrgen is to download a pre-built binary [here](https://github.com/Limeth/ethaddrgen/releases).
You can also compile it yourself, if you wish so.
1. Install [Rust via Rustup.rs](http://rustup.rs/)
2. Clone this repository: `git clone https://github.com/Limeth/ethaddrgen.git; cd ethaddrgen`
3. Compile the project: `cargo build --release`. The binary can then be found at `target/release/ethaddrgen` or `./target/release/ethaddrgen.exe` on Windows machines.

0 comments on commit 0bbf825

Please sign in to comment.