From f18c042fdea85bd97ae7615abaf057b9120618f6 Mon Sep 17 00:00:00 2001
From: cubixle <contact@cubixle.me>
Date: Mon, 19 Feb 2024 17:39:39 +0000
Subject: [PATCH] adding readmes

---
 README.md        |  4 ++++
 lru/README.md    | 14 ++++++++++++++
 lru/coverage.out | 24 ------------------------
 3 files changed, 18 insertions(+), 24 deletions(-)
 create mode 100644 README.md
 create mode 100644 lru/README.md
 delete mode 100644 lru/coverage.out

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ffb9f1b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,4 @@
+# Playground
+
+This is an attempt to organise all the random bit of code I've written over the years.
+
diff --git a/lru/README.md b/lru/README.md
new file mode 100644
index 0000000..3d51962
--- /dev/null
+++ b/lru/README.md
@@ -0,0 +1,14 @@
+# LRU Cache 
+
+This is a simple implementation of a Least Recently Used (LRU) Cache in Go.
+
+An LRU Cache will evict the oldest used key whenever the cache gets full.
+
+Example usage
+```go
+capacity := 100
+cache := lru.NewCache(capacity)
+cache.Set("im a key", "im a value")
+val := cache.Get("im a key")
+println(val)
+```
diff --git a/lru/coverage.out b/lru/coverage.out
deleted file mode 100644
index 935ba51..0000000
--- a/lru/coverage.out
+++ /dev/null
@@ -1,24 +0,0 @@
-mode: set
-github.com/cubixle/lru/lru.go:11.31,17.2 1 1
-github.com/cubixle/lru/lru.go:19.40,21.9 2 1
-github.com/cubixle/lru/lru.go:21.9,23.3 1 0
-github.com/cubixle/lru/lru.go:25.2,25.14 1 1
-github.com/cubixle/lru/lru.go:25.14,27.3 1 0
-github.com/cubixle/lru/lru.go:29.2,29.15 1 1
-github.com/cubixle/lru/lru.go:32.38,34.9 2 1
-github.com/cubixle/lru/lru.go:34.9,39.23 3 1
-github.com/cubixle/lru/lru.go:39.23,46.4 4 1
-github.com/cubixle/lru/lru.go:48.3,48.9 1 1
-github.com/cubixle/lru/lru.go:51.2,52.23 2 0
-github.com/cubixle/lru/lru.go:68.22,70.2 1 1
-github.com/cubixle/lru/lru.go:72.37,73.19 1 1
-github.com/cubixle/lru/lru.go:73.19,78.3 3 1
-github.com/cubixle/lru/lru.go:80.2,85.39 5 1
-github.com/cubixle/lru/lru.go:88.50,97.2 3 1
-github.com/cubixle/lru/lru.go:99.32,100.14 1 1
-github.com/cubixle/lru/lru.go:100.14,102.3 1 0
-github.com/cubixle/lru/lru.go:104.2,108.17 4 1
-github.com/cubixle/lru/lru.go:108.17,110.3 1 0
-github.com/cubixle/lru/lru.go:113.29,116.2 2 1
-github.com/cubixle/lru/lru.go:118.24,120.18 2 1
-github.com/cubixle/lru/lru.go:120.18,123.3 2 1