Skip to content

Commit 475a58f

Browse files
rmccaskillgavinr
andauthored
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>
1 parent 8d265ba commit 475a58f

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ For all actions, the tool will ask you to input a GitHub token. To obtain this t
6565
| Option | Notes |
6666
| ----------------------- | ------------------------------------------------------------------------------|
6767
| -V, --version | Output the version number |
68-
| -g, --github_enterprise | Your GitHub Enterprise URL. https://your-internal-githubenterprise.com/api/v3 |
68+
| -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)|
6969
| -t, --token | The GitHub token. https://github.com/settings/tokens |
70-
| -o, --organization | The User or Organization slug that the repo lives under. |
71-
| -r, --repository | The repository name (slug). |
70+
| -o, --organization | The User or Organization slug that the repo lives under. <br />Example: For `/myOrg/my-repo`, this value would be **myOrg**. |
71+
| -r, --repository | The repository name (slug).<br />Example: For `/myOrg/my-repo`, this value would be **my-repo**. |
7272
| -v, --verbose | Include additional logging information. |
7373
| -h, --help | See all the options and help. |
7474

0 commit comments

Comments
 (0)