commit 475a58f74269a3a51f7c86dc43f6e778b0e5b665
parent 8d265bab6f95d88aca8f1fc9460de47e3c62d763
Author: Rick McCaskill <rick.mccaskill@gmail.com>
Date: Tue, 30 Nov 2021 00:46:15 -0400
Added helpers and explicit examples (#64)
* Added helpers and explicit examples
Added note the make it CLEAR the api path at the end of the enterprise repo is NECESSARY
Added examples around the Org and Repo options
* docs(readme): enterprise reminder
Co-authored-by: Gavin Rehkemper <gavinr@users.noreply.github.com>
Diffstat:
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -65,10 +65,10 @@ For all actions, the tool will ask you to input a GitHub token. To obtain this t
| Option | Notes |
| ----------------------- | ------------------------------------------------------------------------------|
| -V, --version | Output the version number |
-| -g, --github_enterprise | Your GitHub Enterprise URL. https://your-internal-githubenterprise.com/api/v3 |
+| -g, --github_enterprise | Your GitHub Enterprise URL. https://your-internal-githubenterprise.com/api/v3 <br />(Reminder: do not forget the `/api/v3` at the end)|
| -t, --token | The GitHub token. https://github.com/settings/tokens |
-| -o, --organization | The User or Organization slug that the repo lives under. |
-| -r, --repository | The repository name (slug). |
+| -o, --organization | The User or Organization slug that the repo lives under. <br />Example: For `/myOrg/my-repo`, this value would be **myOrg**. |
+| -r, --repository | The repository name (slug).<br />Example: For `/myOrg/my-repo`, this value would be **my-repo**. |
| -v, --verbose | Include additional logging information. |
| -h, --help | See all the options and help. |
