Skip to content

Commit

Permalink
Added Release History
Browse files Browse the repository at this point in the history
  • Loading branch information
bitroniq committed Jul 17, 2018
1 parent 699b3f2 commit 270f341
Showing 1 changed file with 43 additions and 12 deletions.
55 changes: 43 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,49 @@ npm test

## Release History

* 0.2.1
* CHANGE: Update docs (module code remains unchanged)
* 0.2.0
* CHANGE: Remove `setDefaultXYZ()`
* ADD: Add `init()`
* 0.1.1
* FIX: Crash when calling `baz()` (Thanks @GenerousContributorName!)
* 0.1.0
* The first proper release
* CHANGE: Rename `foo()` to `bar()`
* 0.0.1
* Work in progress
> All notable changes to this project will be documented in this section.
> The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
> and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
> ### How do I make a good changelog?
> #### Guiding Principles
> * Changelogs are for humans, not machines.
> * There should be an entry for every single version.
> * The same types of changes should be grouped.
> * Versions and sections should be linkable.
> * The latest version comes first.
> * The release date of each version is displayed.
> * Mention whether you follow Semantic Versioning.
> #### Types of changes
> * `Added` for new features.
> * `Changed` for changes in existing functionality.
> * `Deprecated` for soon-to-be removed features.
> * `Removed` for now removed features.
> * `Fixed` for any bug fixes.
> * `Security` in case of vulnerabilities.
### [Unreleased]

### [v1.1] - 2018-07-17
#### Fixed
- Fixed some typos

#### Added
- This CHANGELOG file to hopefully serve as an evolving example of a
standardized open source project CHANGELOG.

### [v1.0] - 2018-07-17
#### Fixed
- Some typos

[Unreleased]: https://github.com/bitroniq/readme-template/compare/v1.1...HEAD
[v1.1]: https://github.com/bitroniq/readme-template/compare/v1.0...v1.1
[v1.0]: https://github.com/bitroniq/readme-template/compare/ff494e6...v1.0

---

## Meta

Expand Down

0 comments on commit 270f341

Please sign in to comment.