From abe8aec33f479469641065ffd4565e8f0139d5d9 Mon Sep 17 00:00:00 2001
From: "Felipe M." <me@fmartingr.com>
Date: Sun, 23 Mar 2025 23:45:43 +0100
Subject: [PATCH] docs: updated readme

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index 470f864..b2237e8 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,25 @@
 # gotoolkit
 
+[![Go Reference](https://pkg.go.dev/badge/git.nakama.town/fmartingr/gotoolkit.svg)](https://pkg.go.dev/git.nakama.town/fmartingr/gotoolkit)
+
 A set of basic tools to develop Go applications.
 
+# Index
+
+- [Cache](#cache)
+- [Database](#database)
+- [Paths](#paths)
+- [Service & Servers](#service--servers)
+- [Template](#template)
+
+## Cache
+
+A basic cache engine to manage the cache of the application.
+
+```go
+cache := cache.NewMemoryCache()
+```
+
 ## Database
 
 A basic database engine to manage the connection to a database.
@@ -13,6 +31,14 @@ if err != nil {
 }
 ```
 
+## Paths
+
+A basic utility to manage the paths of the application.
+
+```go
+path := paths.ExpandUser("~/myapp")
+```
+
 ## Service & Servers
 
 A basic way to expose servers within one service.