From 0f7dd76106f77ed152cf4381e22820b1fd9956ac Mon Sep 17 00:00:00 2001
From: Lenka Segura <lenka@sepu.cz>
Date: Jul 29 2019 19:05:27 +0000
Subject: README update


---

diff --git a/README.md b/README.md
index ea98ada..903d872 100644
--- a/README.md
+++ b/README.md
@@ -10,23 +10,30 @@ At the moment cranc lists pull requests and issues of a project.
 With this commands:
 
 `cranc get prs`
+
 - `[author]` optional
+
 - `[status]` optional
+
 - `[assignee]` optional
 
 `cranc get issues`
+
 - `[author]` optional
+
 - `[status]` optional
+
 - `[assignee]` optional
 
 `cranc merge pr [request_id]`
 
 `cranc create pr [title] [repo] [brach_from] [branch_to]`
+
 - `[initial_comment]` is optional
 
 ### About its name
 
-Since 'pagure' is a hermit crab, cranc is crab in catalan. `
+Since Pagure is a hermit crab, cranc is crab in catalan.
 
 ### Run
 
@@ -48,15 +55,38 @@ Install dependencies:
 
 Run the setup file. This creates a link in the venv directory pointing to the cranc directory:
 
-`python setup.py develop`
+`python setup.py install`
 
 Run the app:
 
 `cranc`
 
+```
+Usage: cranc [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  -a, --api-key API-KEY    your API key for Pagure.io
+  -r, --repo-url TEXT      Repo url
+  -i, --instance-url TEXT  Pagure instance url
+  -c, --config-file PATH
+  --help                   Show this message and exit.
+
+Commands:
+  config
+  create
+  get
+  merge
+
+```
+
+
+`cranc`
+
 Or run the command:
 
-`cranc get pr`
+`cranc get prs`
+
+`cranc merge pr --request_id [request_id]`
 
 ### Test
 
@@ -66,4 +96,4 @@ To run tests type:
 
 Or to run only 1 test type:
 
-`pytest tests/[name_of_the_test]
+`pytest tests/[name_of_the_test]`