Skip to content

Commit

Permalink
Added CHANGELOG and updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
marcizhu committed Aug 13, 2020
1 parent 07b3ce8 commit 7c917ae
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 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.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [1.0.0] - 2019-08-13
### Added
- Cache object
- FIFO, LFU, LIFO, LRU and MRU replacement policies
- Basic statistics with hit count, miss count, eviction count, etc...
- Function wrapper to speed up expensive function calls
- 10 examples illustrating the usage of this library
- Many tests to verify the behaviour of the library

[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/marcizhu/Cache/releases/tag/v1.0.0
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Cache
[![Build Status](https://travis-ci.com/marcizhu/Cache.svg?branch=master)](https://travis-ci.com/marcizhu/Cache)
[![License](https://img.shields.io/github/license/marcizhu/Cache)](https://github.com/marcizhu/Cache/blob/master/LICENSE)
[![Stability: Experimental](https://masterminds.github.io/stability/experimental.svg)](https://masterminds.github.io/stability/experimental.html)
[![Stability: Sustained](https://masterminds.github.io/stability/sustained.svg)](https://masterminds.github.io/stability/sustained.html)
[![codecov](https://codecov.io/gh/marcizhu/Cache/branch/master/graph/badge.svg)](https://codecov.io/gh/marcizhu/Cache)

A small, lightweight, thread-safe, easy to use, header-only, fast and simple cache with selectable replacement algorithms!

Expand All @@ -20,6 +21,7 @@ development. Any kind of input/feedback is always welcome!
- Ability to have custom callbacks on hit/miss/clear/erase/evicted entry.
- 100% STL-compatible API.
- Ability to 'wrap' functions in a cache to speed up expensive function calls.
- Heavily tested: over 90 test cases, more than 110.000 assertions and >99% code coverage

## Table of contents
- [Background](#background)
Expand Down

0 comments on commit 7c917ae

Please sign in to comment.