update docs and clean up codebase

KyleSanderson · Aug 22, 2023 · 542fed1 · 542fed1
1 parent cbc77ed
commit 542fed1
Show file tree

Hide file tree

Showing 9 changed files with 143 additions and 212 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -1,20 +1,19 @@
-[#](#) TTLCache - an in-memory cache with item expiration
+# TTLCache - an in-memory cache with item expiration and generics
 
 [![Go Reference](https://pkg.go.dev/badge/github.com/jellydator/ttlcache/v3.svg)](https://pkg.go.dev/github.com/jellydator/ttlcache/v3)
 [![Build Status](https://github.com/jellydator/ttlcache/actions/workflows/go.yml/badge.svg)](https://github.com/jellydator/ttlcache/actions/workflows/go.yml)
 [![Coverage Status](https://coveralls.io/repos/github/jellydator/ttlcache/badge.svg?branch=master)](https://coveralls.io/github/jellydator/ttlcache?branch=master)
 [![Go Report Card](https://goreportcard.com/badge/github.com/jellydator/ttlcache/v3)](https://goreportcard.com/report/github.com/jellydator/ttlcache/v3)
 
 ## Features
-- Simple API.
-- Type parameters.
-- Item expiration and automatic deletion.
-- Automatic expiration time extension on each `Get` call.
-- `Loader` interface that is used to load/lazily initialize missing cache 
-items.
-- Subscription to cache events (insertion and eviction).
-- Metrics.
-- Configurability.
+- Simple API
+- Type parameters
+- Item expiration and automatic deletion
+- Automatic expiration time extension on each `Get` call
+- `Loader` interface that may be used to load/lazily initialize missing cache 
+items
+- Event handlers (insertion and eviction)
+- Metrics
 
 ## Installation
 ```