From 0547224f24a0092ac0f27e15425cffe33602dfc8 Mon Sep 17 00:00:00 2001 From: dweller Date: Sat, 9 Mar 2024 03:00:27 +0200 Subject: Add an example to README --- README | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'README') 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 [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. -- cgit v1.2.3