Skip to content

Commit

Permalink
fix headers
Browse files Browse the repository at this point in the history
  • Loading branch information
emad-elsaid committed May 19, 2024
1 parent a7b07ca commit fde5009
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,15 @@ type Cacher[K any, V any] interface {
}
```

# Note on Cacher interface
## Note on Cacher interface

* `memoize` require the cache interface to implement two simple `Load` and `Store` functions
* So you can adapt any other caching library to `memoize`
* This will give you a very powerful memoization patterns where you can store your cache in memory, file, remote system or have failovers with multiple layers of caching.
* This also means `memoize` package will not remove any items from the cache, it's the cache implementation responsibility to manage it's size, TTL, and communication with remote systems
* `memoize` comes with 1 concurrency safe implementation of the cache `Cache`, stored in memory and uses Go generics. packed by `sync.Map`

# Cache subpackage
## Cache subpackage

* `memoize` include a subpackage `cache` which provides several implementations for the `Cacher` interface
* `Cache` is a simple in-memory forever cacher
Expand All @@ -79,7 +79,7 @@ type Cacher[K any, V any] interface {
> [!IMPORTANT]
> This package is still being tested, use it with caution
# Brenchmarks
## Brenchmarks

Each struct is tested with two benchmarks:
* Sequencial executions
Expand Down

0 comments on commit fde5009

Please sign in to comment.