From 09c2f9a224b483b7cae43113eb820db1489b0022 Mon Sep 17 00:00:00 2001 From: Lenka Segura Date: Mar 07 2019 08:59:06 +0000 Subject: README update --- diff --git a/README.md b/README.md index 13daea4..1375645 100644 --- a/README.md +++ b/README.md @@ -10,23 +10,36 @@ 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. ` - ### Run Create the virtual environment: `virtualenv3 ~/venvs/cranc-env` + `source ~/venvs/cranc-env/bin/activate` Retrieve the sources: `git clone https://pagure.io.cranc.git` + `cd cranc` Install dependencies: @@ -43,7 +56,7 @@ Run the app: Or run the command: -`cranc pr list` +`cranc get pr` ### Test