From 7772fb9a3d0b5017ada8512d701a31d9f7be2447 Mon Sep 17 00:00:00 2001
From: danijoo <danijoo@users.noreply.github.com>
Date: Thu, 24 Sep 2015 00:37:29 +0200
Subject: [PATCH] Update README.md

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/README.md b/README.md
index 5b68436..a7a31e7 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,49 @@
 # resdiff
 A tool for comparing android resource files similar to unix diff
+
+## Usage
+
+```
+danijoo > .\resdiff --help
+usage: resdiff [OPTIONS]... FILES
+ -h,--help           Show this screen
+ -t,--type <arg>     only compare this resource type (string, bool,
+                     integer, color, dimen)
+ -y,--side-by-side   output in columns
+```
+
+## Examples
+### Table view
+```
+danijoo > .\resdiff -y resourcefile1.xml resourcefile2.xml
+Found 9 differences (1 added, 2 removed).
++-----------+--------------------------+-------------------------------+-----------------------------------+
+|    Type   |           Name           |              Left             |               Right               |
++-----------+--------------------------+-------------------------------+-----------------------------------+
+|    String |      not_matching_string | This resource is not matching | This resource is not matching!!!! |
+|    String |       missing_string_res | This misses in the other file |                                   |
+|    String |       res_with_reference |      @string/is_just_a_string |    @string/is_just_another_string |
+|    String |         added_string_res |                               |     This misses in the other file |
+|   Boolean |        not_matching_bool |                         false |                              true |
+|   Boolean |        a_missing_boolean |                          true |                                   |
+|   Integer |         not_matching_int |                           122 |                               533 |
+| Dimension |       not_matching_dimen |                           1sp |                              99px |
+|     Color |       not_matching_color |                       #001230 |                           #666666 |
++-----------+--------------------------+-------------------------------+-----------------------------------+
+```
+
+### Normal view
+```
+danijoo > .\resdiff resourcefile1.xml resourcefile2.xml
+Found 9 differences (1 added, 2 removed).
+<string name="not_matching_res">
+<	This resource is not matching
+---
+>	This resource is not matching!!!!
+<string name="missing_string_res">
+<	This misses in the other file
+<string name="a_reference_not_matching">
+<	@string/is_just_a_string
+---
+>	@string/is_just_another_string
+