diff --git a/README.md b/README.md index ebd4289..8ea3a8b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ -# ExpiryMap +

+ Go Reference + Github action + Latest Release +

+ +## ExpiryMap This Go package provides a map that automatically removes entries after a given expiry delay. -## Features +### Features * The map key can be any comparable type * The map value can be any type * The map is safe for concurrent use * The expiry delay is specified as a `time.Duration` value -## Methods +### Methods * NewExpiryMap - creates a new ExpiryMap * Get, Set, Delete - standard map operations @@ -18,6 +24,6 @@ This Go package provides a map that automatically removes entries after a given * Clear - removes all entries from the map * Stop - stops the background goroutine that removes expired entries -## Example +### Example See [example/simple/simple.go](./example/simple/simple.go)