tyler.durden/keep-a-changelog
1
0
Fork 0
mirror of https://github.com/olivierlacan/keep-a-changelog.git synced 2025-07-31 01:34:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

Bump to 1.0.0 in README

Browse Source
This commit is contained in:
Olivier Lacan 2017-06-20 10:23:30 +01:00
parent d20c188ff2
commit f9945877e8
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,6 +1,6 @@
# <img src="https://d3vv6lp55qjaqc.cloudfront.net/items/1L1w0v431V0d1K410f3Y/keepAChangelog-logo-dark.svg" height=150 alt="Keep a Changelog" /> # <img src="https://d3vv6lp55qjaqc.cloudfront.net/items/1L1w0v431V0d1K410f3Y/keepAChangelog-logo-dark.svg" height=150 alt="Keep a Changelog" />
[![version][version-badge]][CHANGELOG] [![license][license-badge]][LICENSE] [![version][version-badge]][CHANGELOG] [![license][license-badge]][LICENSE]
Don’t let your friends dump git logs into changelogs™ Don’t let your friends dump git logs into changelogs™
@ -20,12 +20,12 @@ This repository generates http://keepachangelog.com/.
- `bundle exec middleman` starts the local development server at http://localhost:4567 - `bundle exec middleman` starts the local development server at http://localhost:4567
### Deployment ### Deployment
- `rake publish` builds and pushes to the `gh-pages` branch - `rake publish` builds and pushes to the `gh-pages` branch
### Translations ### Translations
Create a new directory in [`source/`][source] named after the ISO 639-1 code Create a new directory in [`source/`][source] named after the ISO 639-1 code
for the language you wish to translate Keep a Changelog to. For example, for the language you wish to translate Keep a Changelog to. For example,
assuming you want to translate to French Canadian: assuming you want to translate to French Canadian:
- create the `source/fr-CA` directory. - create the `source/fr-CA` directory.
- duplicate the `source/en-US/index.html.haml` file in `source/fr-CA`. - duplicate the `source/en-US/index.html.haml` file in `source/fr-CA`.
@ -33,9 +33,9 @@ assuming you want to translate to French Canadian:
- commit your changes to your own [fork][fork] - commit your changes to your own [fork][fork]
- submit a [Pull Request][pull-request] with your changes - submit a [Pull Request][pull-request] with your changes
It may take some time to review your submitted Pull Request. Try to involve a It may take some time to review your submitted Pull Request. Try to involve a
few native speakers of the language you're translating to in the Pull Request few native speakers of the language you're translating to in the Pull Request
comments. They'll help review your translation for simple mistakes and give us comments. They'll help review your translation for simple mistakes and give us
a better idea of whether your translation is accurate. a better idea of whether your translation is accurate.
Thank you for your help improving software one changelog at a time! Thank you for your help improving software one changelog at a time!
@ -47,5 +47,5 @@ Thank you for your help improving software one changelog at a time!
[source]: source/ [source]: source/
[pull-request]: https://help.github.com/articles/creating-a-pull-request/ [pull-request]: https://help.github.com/articles/creating-a-pull-request/
[fork]: https://help.github.com/articles/fork-a-repo/ [fork]: https://help.github.com/articles/fork-a-repo/
[version-badge]: https://img.shields.io/badge/version-0.3.0-blue.svg [version-badge]: https://img.shields.io/badge/version-1.0.0-blue.svg
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg [license-badge]: https://img.shields.io/badge/license-MIT-blue.svg