From 0e5fa01bcf7ae3ac7c395f519e21a156b822763c Mon Sep 17 00:00:00 2001
From: Dmitry Verkhoturov <paskal.07@gmail.com>
Date: Tue, 12 May 2020 16:54:42 +0200
Subject: [PATCH] add Readme

---
 README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 cache.go  | 16 ++++++-------
 2 files changed, 74 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 01d90a8..b291161 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,66 @@
-# expirable-cache
\ No newline at end of file
+# expirable-cache
+
+[![Build Status](https://github.com/go-pkgz/expirable-cache/workflows/build/badge.svg)](https://github.com/go-pkgz/expirable-cache/actions)
+[![Coverage Status](https://coveralls.io/repos/github/go-pkgz/expirable-cache/badge.svg?branch=master)](https://coveralls.io/github/go-pkgz/expirable-cache?branch=master)
+[![godoc](https://godoc.org/github.com/go-pkgz/expirable-cache?status.svg)](https://pkg.go.dev/github.com/go-pkgz/expirable-cache?tab=doc)
+
+Package cache implements LoadingCache similar to [hashicorp/golang-lru](https://github.com/hashicorp/golang-lru).
+
+- Support LRC, LRU and TTL-based eviction.
+- Package is thread-safe and doesn't spawn any goroutines.
+- On every Set() call, cache deletes single oldest entry in case it's expired.
+- In case MaxSize is set, cache deletes the oldest entry disregarding its expiration date to maintain the size,
+either using LRC or LRU eviction.
+- In case of default TTL (10 years) and default MaxSize (0, unlimited) the cache will be truly unlimited
+ and will never delete entries from itself automatically.
+
+**Important**: only reliable way of not having expired entries stuck in a cache is to
+run cache.DeleteExpired periodically using [time.Ticker](https://golang.org/pkg/time/#Ticker),
+advisable period is 1/2 of TTL.
+
+### Usage example
+
+```go
+package main
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/go-pkgz/expirable-cache"
+)
+
+func main() {
+	// make cache with short TTL and 3 max keys
+	lc, _ := cache.NewLoadingCache(cache.MaxKeys(3), cache.TTL(time.Millisecond*10))
+
+	// set value under key1
+	lc.Set("key1", "val1")
+
+	// get value under key1
+	r, ok := lc.Get("key1")
+
+	// check for OK value, because otherwise return would be nil and
+	// type conversion will panic
+	if ok {
+		rstr := r.(string) // convert cached value from interface{} to real type
+		fmt.Printf("value before expiration is found: %v, value: %v\n", ok, rstr)
+	}
+
+	time.Sleep(time.Millisecond * 11)
+
+	// get value under key1 after key expiration
+	r, ok = lc.Get("key1")
+	// don't convert to string as with ok == false value vould be nil
+	fmt.Printf("value after expiration is found: %v, value: %v\n", ok, r)
+
+	// set value under key2, would evict old entry because it is already expired
+	lc.Set("key2", "val2")
+
+	fmt.Printf("%+v\n", lc)
+	// Output:
+	// value before expiration is found: true, value: val1
+	// value after expiration is found: false, value: <nil>
+	// Size: 1, Stats: {Hits:1 Misses:1 Added:2 Evicted:1} (50.0%)
+}
+```
\ No newline at end of file
diff --git a/cache.go b/cache.go
index 969a77f..a5ff71c 100644
--- a/cache.go
+++ b/cache.go
@@ -2,14 +2,14 @@
 //
 // Support LRC, LRU and TTL-based eviction.
 // Package is thread-safe and doesn't spawn any goroutines.
-// On every Set() call, cache deletes single oldest entry in cache in case it's expired.
-// In case MaxSize is set, cache deletes oldest entry disregarding it's expiration date to maintain the size.
-//
-// Important: only reliable way of not having expired entries stuck in cache is to
-// run DeleteExpired by time.Ticker, advisable time is 1/2 of TTL.
-//
+// On every Set() call, cache deletes single oldest entry in case it's expired.
+// In case MaxSize is set, cache deletes the oldest entry disregarding its expiration date to maintain the size,
+// either using LRC or LRU eviction.
 // In case of default TTL (10 years) and default MaxSize (0, unlimited) the cache will be truly unlimited
 // and will never delete entries from itself automatically.
+//
+// Important: only reliable way of not having expired entries stuck in a cache is to
+// run cache.DeleteExpired periodically using time.Ticker, advisable period is 1/2 of TTL.
 package cache
 
 import (
@@ -43,7 +43,7 @@ type Stats struct {
 	Added, Evicted int // number of added and evicted records
 }
 
-// loadingCacheImpl provides loading cache, implements cache.LoadingCache.
+// loadingCacheImpl provides loading cache, implements LoadingCache interface.
 type loadingCacheImpl struct {
 	ttl       time.Duration
 	maxKeys   int
@@ -59,7 +59,7 @@ type loadingCacheImpl struct {
 // noEvictionTTL - very long ttl to prevent eviction
 const noEvictionTTL = time.Hour * 24 * 365 * 10
 
-// NewLoadingCache returns a new cache.
+// NewLoadingCache returns a new LoadingCache.
 // Default MaxKeys is unlimited (0).
 // Default TTL is 10 years, sane value for expirable cache is 5 minutes.
 // Default eviction mode is LRC, appropriate option allow to change it to LRU.