From 0bbf8252886d25bef4b17c5c491e4c110db596d0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20Hlusi=C4=8Dka?= <Limeth@users.noreply.github.com>
Date: Sun, 4 Jun 2017 15:17:25 +0200
Subject: [PATCH] improved README.md

---
 README.md | 25 ++++++++++++++++---------
 1 file changed, 16 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 01bafe8..4ae3384 100644
--- a/README.md
+++ b/README.md
@@ -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.