Skip to content

Commit

Permalink
Add a Changelog (#11)
Browse files Browse the repository at this point in the history
* Add changelog

* readme

* Remove redundant redundantness
  • Loading branch information
AngheloAlf authored Dec 28, 2023
1 parent 39250df commit 29ed50b
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- CHANGELOG.md file.

## [0.2.0] - 2023-12-28

### Added

- MIO0 compression and decompression.

## [0.1.1] - 2023-12-16

### Fixed

- CI for release.

## [0.1.0] - 2023-12-16 [YANKED]

### Added

- Yay0 compression and decompression.
- Yaz0 compression and decompression.
- Python bindings.
- C bindings.

[unreleased]: https://github.com/decompals/crunch64/compare/0.2.0...HEAD
[0.2.0]: https://github.com/decompals/crunch64/compare/0.1.1...0.2.0
[0.1.1]: https://github.com/decompals/crunch64/compare/0.1.0...0.1.1
[0.1.0]: https://github.com/decompals/crunch64/releases/tag/0.1.0
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ python3 -m pip install "git+https://github.com/decompals/crunch64.git#egg=crunch

NOTE: Installing the development version is not recommended unless you know what you are doing. Proceed at your own risk.

## Versioning and changelog

This library follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

To see what changed on each release check either the [CHANGELOG.md](CHANGELOG.md)
file or check the [releases page on Github](https://github.com/decompals/crunch64/releases).
You can also use [this link](https://github.com/decompals/crunch64/releases/latest)
to check the latest release.

## References

- Yaz0
Expand Down

0 comments on commit 29ed50b

Please sign in to comment.