Skip to content

Commit

Permalink
doc: add new interactive commands.
Browse files Browse the repository at this point in the history
  • Loading branch information
ldez committed Apr 13, 2018
1 parent a264f23 commit a332760
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ image:https://asciinema.org/a/158378.png["prm", link="https://asciinema.org/a/15
Feature:

* Checkout a PR by his number.
* Checkout (get) a PR into a list of PRs from GitHub.
* Remove (clean) a PR by his number.
* Remove (clean) all PR for a project.
* Push force a PR (auto).
Expand All @@ -21,7 +22,6 @@ Feature:
== How to Install


[source, shell]
----
go get -u github.com/ldez/prm
Expand All @@ -35,6 +35,8 @@ or

== Checkout

=== By Number

[source, shell]
----
prm c -n 1234
Expand All @@ -47,6 +49,31 @@ prm c --number=1234
+
ex: `1234\--myBranch`

=== Interactive (Local)

[source, shell]
----
prm
----

* Choose a PR between all "local" PRs.
* Checkout the PR branch named like that: `<PR_NUMBER>--<BRANCH_NAME>`
+
ex: `1234\--myBranch`

=== Interactive (Remote)

[source, shell]
----
prm g
----

* Add the user git remote named with the user login.
* Display the last 25 PRs from GitHub.
* Checkout the PR branch named like that: `<PR_NUMBER>--<BRANCH_NAME>`
+
ex: `1234\--myBranch`

== Remove

=== By Number
Expand All @@ -73,6 +100,28 @@ prm rm --all
* Remove all PR related local branches.
* Remove all PR related git remote.

=== Interactive

Only for the current project.

[source, shell]
----
prm rm
----

* Display all "local" PRs.
* Remove by one or remove all.

== Push

[source, shell]
----
prm push
----

* Push to the PR related branch.
* Detect the PR number from the branch name.

== Push Force

[source, shell]
Expand Down

0 comments on commit a332760

Please sign in to comment.