From 25c7856e193b7e84773155310c97a21c469d9a7c Mon Sep 17 00:00:00 2001 From: Christopher McCulloh Date: Tue, 12 Jul 2016 16:03:02 -0400 Subject: [PATCH 1/2] Adds documentation on using a GHE endpoint --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 9275b8c..7f2afdd 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,10 @@ Because software tools are for people. If you don’t care, why are you contribu - `github_changelog_generator -u github_username -p github_project` - `github_changelog_generator github_username/github_project` +- If you are running it against a repository on a Github Enterprise install, you must specify *both* `--github-site` and `--github-api` command line options: + + github_changelog_generator --github-site=«https://github.yoursite.com» --github-api=«https://github.yoursite.com/api/v3/» + This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting. ### Params From bb87462e3aea704e6750e2b556fed5c2a45d498e Mon Sep 17 00:00:00 2001 From: Christopher McCulloh Date: Wed, 13 Jul 2016 20:56:41 -0400 Subject: [PATCH 2/2] Addresses some formatting issues --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f2afdd..39ca501 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,8 @@ Because software tools are for people. If you don’t care, why are you contribu - If you are running it against a repository on a Github Enterprise install, you must specify *both* `--github-site` and `--github-api` command line options: - github_changelog_generator --github-site=«https://github.yoursite.com» --github-api=«https://github.yoursite.com/api/v3/» + github_changelog_generator --github-site="https://github.yoursite.com" \ + --github-api="https://github.yoursite.com/api/v3/" This generates a changelog to the `CHANGELOG.md` file, with pretty markdown formatting.