Update module and readme

README.md

@@ -1,30 +1,42 @@
 # evcache
 
-[![Go Reference](https://pkg.go.dev/badge/github.com/mgnsk/evcache/v3.svg)](https://pkg.go.dev/github.com/mgnsk/evcache/v3)
-[![Go Report Card](https://goreportcard.com/badge/github.com/mgnsk/evcache/v3)](https://goreportcard.com/report/github.com/mgnsk/evcache/v3)
+[![Go Reference](https://pkg.go.dev/badge/github.com/mgnsk/evcache/v4.svg)](https://pkg.go.dev/github.com/mgnsk/evcache/v4)
+[![Go Report Card](https://goreportcard.com/badge/github.com/mgnsk/evcache/v4)](https://goreportcard.com/report/github.com/mgnsk/evcache/v4)
 
 Package evcache implements a concurrent key-value cache with capacity overflow eviction, item expiry and deduplication.
 
-`import "github.com/mgnsk/evcache/v3"`
-
-Package evcache implements a concurrent key-value cache with capacity overflow eviction, item expiry and deduplication.
+`import "github.com/mgnsk/evcache/v4"`
 
 ### Example
 
 ```go
-c := evcache.New[string, string](10)
-
-// Fetches an existing value or calls the callback to get a new value.
-result, err := c.Fetch("key", time.Minute, func() (string, error) {
-	// Possibly a very long network call. It only blocks write access to this key.
-	// Read access to the key is always non-blocking.
-	return "value", nil
-})
-
-if err != nil {
-    return err
+package main
+
+import (
+	"time"
+
+	"github.com/mgnsk/evcache/v4"
+)
+
+func main() {
+	c := evcache.New[string, string](
+		evcache.WithCapacity(128),
+		evcache.WithPolicy(evcache.LRU),
+		evcache.WithTTL(time.Minute),
+	)
+
+	// Fetches an existing value or calls the callback to get a new value.
+	result, err := c.Fetch("key", func() (string, error) {
+		// Possibly a very long network call. It only blocks write access to this key.
+		// Read access for this key returns as if the value does not exist.
+		return "value", nil
+	})
+
+	if err != nil {
+		panic(err)
+	}
+
+	// Use the result.
+	println(result)
 }
-
-// Use the result.
-_ = result
 ```

bench_test.go

@@ -5,7 +5,7 @@ import (
 	"sync/atomic"
 	"testing"
 
-	"github.com/mgnsk/evcache/v3"
+	"github.com/mgnsk/evcache/v4"
 )
 
 func BenchmarkFetchAndEvictParallel(b *testing.B) {

cache.go

@@ -1,13 +1,10 @@
-/*
-Package evcache implements a concurrent key-value cache with capacity overflow eviction, item expiry and deduplication.
-*/
 package evcache
 
 import (
 	"runtime"
 	"time"
 
-	"github.com/mgnsk/evcache/v3/internal/backend"
+	"github.com/mgnsk/evcache/v4/internal/backend"
 )
 
 // Cache is an in-memory cache.

cache_test.go

@@ -4,7 +4,7 @@ import (
 	"runtime"
 	"testing"
 
-	"github.com/mgnsk/evcache/v3"
+	"github.com/mgnsk/evcache/v4"
 )
 
 func TestCacheGoGC(t *testing.T) {

doc.go

@@ -1,4 +1,4 @@
 /*
-Package evcache implements a key-value cache with capacity overflow eviction, item expiry and deduplication.
+Package evcache implements a concurrent key-value cache with capacity overflow eviction, item expiry and deduplication.
 */
 package evcache

example/main.go

@@ -0,0 +1,29 @@
+package main
+
+import (
+	"time"
+
+	"github.com/mgnsk/evcache/v4"
+)
+
+func main() {
+	c := evcache.New[string, string](
+		evcache.WithCapacity(128),
+		evcache.WithPolicy(evcache.LRU),
+		evcache.WithTTL(time.Minute),
+	)
+
+	// Fetches an existing value or calls the callback to get a new value.
+	result, err := c.Fetch("key", func() (string, error) {
+		// Possibly a very long network call. It only blocks write access to this key.
+		// Read access for this key returns as if the value does not exist.
+		return "value", nil
+	})
+
+	if err != nil {
+		panic(err)
+	}
+
+	// Use the result.
+	println(result)
+}

go.mod

@@ -1,4 +1,4 @@
-module github.com/mgnsk/evcache/v3
+module github.com/mgnsk/evcache/v4
 
 go 1.22
 

internal/backend/backend_test.go

@@ -7,8 +7,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/mgnsk/evcache/v3/internal/backend"
-	. "github.com/mgnsk/evcache/v3/internal/testing"
+	"github.com/mgnsk/evcache/v4/internal/backend"
+	. "github.com/mgnsk/evcache/v4/internal/testing"
 )
 
 func TestFetchCallbackBlocks(t *testing.T) {

internal/backend/benchmark_test.go

@@ -9,7 +9,7 @@ import (
 	"sync/atomic"
 	"testing"
 
-	"github.com/mgnsk/evcache/v3/internal/backend"
+	"github.com/mgnsk/evcache/v4/internal/backend"
 )
 
 func BenchmarkSliceLoop(b *testing.B) {

internal/backend/element_test.go

@@ -4,8 +4,8 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/mgnsk/evcache/v3/internal/backend"
-	. "github.com/mgnsk/evcache/v3/internal/testing"
+	"github.com/mgnsk/evcache/v4/internal/backend"
+	. "github.com/mgnsk/evcache/v4/internal/testing"
 )
 
 func TestRecordSize(t *testing.T) {

options.go

@@ -3,7 +3,7 @@ package evcache
 import (
 	"time"
 
-	"github.com/mgnsk/evcache/v3/internal/backend"
+	"github.com/mgnsk/evcache/v4/internal/backend"
 )
 
 // Available cache eviction policies.