will/github-changelog-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #396 from cormacmccarthy/patch-2

Browse Source 
Adds documentation on using a GHE endpoint
This commit is contained in:
Olle Jonsson 2016-07-14 16:38:17 +02:00 committed by GitHub
commit 074320d925
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -77,6 +77,11 @@ 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