summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authordweller <dweller@cabin.digital>2024-03-09 03:00:27 +0200
committerdweller <dweller@cabin.digital>2024-03-09 03:00:27 +0200
commit0547224f24a0092ac0f27e15425cffe33602dfc8 (patch)
tree2caeea6198058f674ad14f8ac4c4345d1aeb4c90 /README
parent46cbece3d34830ab5bc995e4c39aab0deed33bab (diff)
Add an example to README
Diffstat (limited to '')
-rw-r--r--README7
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index e33a6b3..31a18a0 100644
--- a/README
+++ b/README
@@ -24,6 +24,13 @@ Install/Usage:
4. That's it for the remote, now copy (or `ln -s` from this repo) `git-description` and
`git-mkremote` to somewhere that is in your $PATH. Now you can access them by calling
`git mkremote/descremote`. All of them provide usage example when called without arguments;
+ Example:
+ ```
+ $ git mkremote
+ Usage: git-mkremote <name> <server> <repo name> [description]
+ $ git mkremote local git@local.lan public/gitscripts collection of scripts for git
+ $ git push --set-upstream local master
+ ```
5. That's it! Now you can create remotes easily from the comfort of your terminal, like a normal
terminally terminal person.