Skip to content

Commit 4d1b2ee

Browse files
committed
chore(README): add usage
1 parent 0497a68 commit 4d1b2ee

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<p align="center">Providing Git shortcuts as well as a drinking problem and occasional yelling.</p>
44
<p align="center">
55
A Git CLI wrapper that provides shortcuts for useful Git commands you'd usually forget after searching.<br>
6-
Mix and match arguments like picking what to add in your drinks. The bartender will <i>probably</i> get them right for you.
6+
As long as something looks enough like a command, the bartender will <i>probably</i> get it right for you, so be as drunk as you'd like!
77
</p>
88

99
# ⬇️ Installation
@@ -25,4 +25,27 @@ Mix and match arguments like picking what to add in your drinks. The bartender w
2525

2626
# 🍹 Usage
2727

28-
Documentation are coming soon.
28+
| Command | Description | Aliases | Usage/Examples |
29+
| ----------------------- | ---------------------------------------------------------------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------- |
30+
| help | Shows the manual, so I can deal with less bullshit from you. | h | `gb help` <br> `gb help [command]` <br> `gb help [alias]` |
31+
| abort | What ya mom should've done years ago. Aborts a stuck process. | ab | `gb abort` |
32+
| discard | Wasted time on something that didn't work? | explode, dc | `gb discard` |
33+
| github | Things related to the Hub- shit. Walked myself right into that one. | gh | `gb github <subcommand>` |
34+
| github actions | Just pushed your changes? Want to watch the deployment fail? | a, action | `gb github actions` <br> `gb github actions [workflow]` <br> `gb github actions [workflow] --branch [branch]` <br> `gb github actions [workflow] -b [branch]` |
35+
| github pull-request | Open a pull request. What did you expect? | pr, pullrequest | `gb github pull-request` <br> `gb github pull-request <target_branch>` <br> `gb github pull-request <target_remote>/[target_branch]` <br> `gb github pull-request <target_remote>/[target_branch]:<from_remote>/[from_branch]` <br> <br>**Examples:** <br> `gb github pull-request dev` <br> `gb github pull-request upstream/main` <br> `gb github pull-request dev:staging` <br> `gb github pull-request dev:upstream/main` <br> `gb github pull-request /main:upstream/` |
36+
| ignore | Ignore your files, like ignoring your problems. | i | `gb ignore [...patterns]` <br> `gb ignore` (view ignored files) |
37+
| pet | Petting me? Seriously? | | `gb pet` |
38+
| unignore | Unignoring your problems now? Good for you. | u | `gb unignore [...patterns]` |
39+
| undo | Uncommits your commits because you have commitment issues. | ud | `gb undo [amount]` |
40+
| unstage | Did you fuckin' stage .env? Remove that! | unadd, !add | `gb unstage [...files]` |
41+
42+
# ⏱️ Future Plans
43+
44+
- Add `gb github actions Owner/Repo` (notice `Owner/Repo`)
45+
- Make `gb help` show examples
46+
- Auto-correcting arguments like branch names passed into `gb github pull-request`
47+
- Add `gb continue` (to continue whatever operation you're stuck on)
48+
- Add `gb list` (lists files based on predefined filters)
49+
- Add `gb push` (pushes with attempts to fix when it fails)
50+
- Add `gb pull` (pulls with attempts to fix when it fails)
51+
- Add `gb add` (`git add` with staging certain ranges, but you type it all out instead of doing it in interactive staging)

0 commit comments

Comments
 (0)