Skip to content

Commit e3e8779

Browse files
authored
Revise README for clarity and feature updates
Updated README to improve clarity and correctness of descriptions, including logo and caching features.
1 parent 3f3ee33 commit e3e8779

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
<p align="center">
2-
<img src="media/logo-small.png" alt="fido logo" width="200">
3-
</p>
41

5-
# fido
2+
# Fido
63

74
[![Go Report Card](https://goreportcard.com/badge/github.com/codeGROOVE-dev/fido)](https://goreportcard.com/report/github.com/codeGROOVE-dev/fido)
85
[![Go Reference](https://pkg.go.dev/badge/github.com/codeGROOVE-dev/fido.svg)](https://pkg.go.dev/github.com/codeGROOVE-dev/fido)
96
[![Release](https://img.shields.io/github/v/release/codeGROOVE-dev/fido)](https://github.com/codeGROOVE-dev/fido/releases)
107
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
118

12-
fido is the most well-rounded cache implementation for Go today.
9+
<img src="media/logo-small.png" alt="fido logo" width="200">
1310

14-
Designed for real-world applications in unstable environments, it has a higher average hit rate, higher throughput, and lower latency for production workloads than any other cache. To deal with process eviction in environments like Kubernetes, Cloud Run, or Borg, it also offers an optional persistence tier.
11+
fido is a high-performance cache for Go, focusing on high hit-rates, high throughput, and low latency. Optimized using the best algorithms and lock-free data structures, nobody fetches better than Fido. Designed to thrive in unstable environments like Kubernetes, Cloud Run, or Borg, it also features an optional multi-tier persistence architecture.
12+
13+
As of January 2026, nobody fetches better - and we have the benchmarks to prove it.
1514

1615
## Install
1716

@@ -22,19 +21,19 @@ go get github.com/codeGROOVE-dev/fido
2221
## Use
2322

2423
```go
25-
cache := fido.New[string, int](fido.Size(10000))
26-
cache.Set("answer", 42)
27-
val, ok := cache.Get("answer")
24+
c := fido.New[string, int](fido.Size(10000))
25+
c.Set("answer", 42)
26+
val, ok := c.Get("answer")
2827
```
2928

3029
With persistence:
3130

3231
```go
33-
store, _ := localfs.New[string, User]("myapp", "")
34-
cache, _ := fido.NewTiered(store)
32+
store, err := localfs.New[string, User]("myapp", "")
33+
cache, err := fido.NewTiered(store)
3534

36-
_ = cache.Set(ctx, "user:123", user) // sync write
37-
_ = cache.SetAsync(ctx, "user:456", user) // async write
35+
err = cache.Set(ctx, "user:123", user) // sync write
36+
err = cache.SetAsync(ctx, "user:456", user) // async write
3837
```
3938

4039
GetSet deduplicates concurrent loads to prevent thundering herd situations:

0 commit comments

Comments
 (0)