update readme

solutionstack · solutionstack · commit eb5016695330 · 2022-06-29T22:09:28.000+01:00
diff --git a/README.md b/README.md
@@ -1,2 +1,49 @@
 # lcache
-A simple LRU based cache in Go
+
+Cache library for golang. It supports LFU currently.
+
+## Features
+
+* Supports  LFU.
+
+* Goroutine safe.
+
+## Install
+
+```
+$ go get github.com/solutionstack/lcache
+```
+
+## Example
+
+### Set a key-value pair.
+
+```go
+package main
+
+import (
+  "github.com/solutionstack/lcache"
+  "fmt"
+)
+
+func main() {
+  lc := lcache.NewCache(20) //optional size parameter to NewCache
+  lc.Write("key", "ok")
+  
+  result := gc.Read("key")
+  
+  if  result.Error != nil {
+    panic( result.Error  )
+  }
+  fmt.Println("Read:", result.Value)
+}
+
+```
+
+
+# Author
+
+**Olubodn Agbalaya**
+
+* <http://github.com/solutionstack>
+* <s.stackng@protonmail.com>
