Update Readme

Author: povils

README.rst

@@ -1,5 +1,5 @@
-git-wipe: A command-line tool that helps you clean up fork branches that have been merged into parent as Pull Requests
-=====================================================
+git-wipe: Cleanup your fork branches which were merged as PR to parent repository
+=================================================================================
 
 .. image:: https://coveralls.io/repos/github/povils/git-wipe/badge.svg?branch=master
     :target: https://coveralls.io/github/povils/git-wipe?branch=master
@@ -9,3 +9,70 @@ git-wipe: A command-line tool that helps you clean up fork branches that have be
 
 ---------------
 
+
+The problem
+-----------------
+From time to time if you have many forks and do many pull requests it is inevitable that you will have stale branches. And as time marches on the number of these branches across forks can become big.
+
+The answer
+-----------
+**git-wipe** is simple command line tool to cleanup your Github fork branches.
+
+Install
+-------
+
+::
+
+    $ pip install git-wipe
+
+Usage
+------
+In order to use **git-swipe** first you need to create your `Personal Access Token <https://github.com/settings/tokens>`_.
+
+You can set this token to your environment variable:
+
+::
+
+    $ export GIT_WIPE_TOKEN=your_access_token
+
+And then you can easily:
+
+
+::
+
+    $ git-wipe cleanup
+    Searching for branches. This may take a while...
+    Founded branches:
+
+    povils/repo_1/Branch_1
+    povils/repo_1/Branch_2
+    povils/repo_2/Branch_1
+    povils/repo_3/Branch_1
+
+    Total: 4
+    Delete these branches? [y/N]: y
+
+
+Other options
+-------------
+::
+
+      --token              instead of environment
+      --preview            just to preview merged branches
+      --timeout            set connection timeout. Default 30 seconds
+      --skip-repository    skip repository you don't want to search. Multiple
+      --skip-branch        skip branch you don't want to delete. Multiple
+      --no-interaction     do not ask any interactive question
+
+Example:
+
+::
+
+    $ git-wipe cleanup --skip-repository=repo_1 --skip-branch=develop --no-interaction
+
+This command will clean all merged branches without interaction, except from fork with name 'repo_1' and except all branches with name 'develop'
+
+Note:
+-----
+Only forks where you are **owner** will be involved in search. Also **master branches will never be deleted!**
+

git_wipe/cli.py

@@ -40,6 +40,7 @@ def cleanup(token, timeout, skip_repository, skip_branch, preview, no_interactio
         with blindspin.spinner():
             repo_branches = github_client.get_merged_fork_branches(
                 skip_repository, skip_branch)
+        click.echo(crayons.yellow('Founded branches:\n'))
     except BadCredentialsException:
         click.echo(crayons.red(
             'Bad credentials. Please provide valid access token'), err=True)
@@ -52,7 +53,7 @@ def cleanup(token, timeout, skip_repository, skip_branch, preview, no_interactio
 
     if False == preview:
         if False == no_interaction:
-            click.confirm(crayons.green('Delete these branches?'), abort=True)
+            click.confirm(crayons.green('\nDelete these branches?'), abort=True)
         click.echo(crayons.green('Deleting branches...'))
         with blindspin.spinner():
             github_client.delete_branches(repo_branches)