Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): fix link to the .changelogrc section #55

Merged
merged 1 commit into from
Jul 21, 2016
Merged

docs(readme): fix link to the .changelogrc section #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@

## Breaking changes

Since version `1.0.0` git-changelog has included the [`.changelogrc` specification](#changelog_specification) and has discontinued the next options:
- `grep_commits` option has been removed in favour of the changelogrc options
Since version `1.0.0` git-changelog has included the [`.changelogrc` specification](#changelogrc-specification) and has discontinued the next options:
- `grep_commits` option has been removed in favour of the `.changelogrc` options
- `tag = false`, in addition to pick logs from the begining of the project, now groups the commits by tag [see example]. **TODO**
- `tag = false` && `group=false` will log from the begining of the project, without grouping by tag **TODO**
- `repo_url` fixed as parameter
- `repo_url` fixed as parameter
- `branch_name` changed to `branch`

## `.changelogrc` specification
Expand All @@ -55,7 +55,7 @@ The `.changelogrc` file contains the "standard commit guideliness" that you and
This specification is used to grep the commits on your log, it contains a valid JSON that will tell git-changelog which sections to include on the changelog.

```javascript
{
{
"app_name": "Git Changelog",
"logo": "https://github.com/rafinskipg/git-changelog/raw/master/images/git-changelog-logo.png",
"intro": "Git changelog is a utility tool for generating changelogs. It is free and opensource. :)",
Expand Down