add simple example to readme

LightningDev1 · Jul 16, 2023 · 6ba4794 · 6ba4794
1 parent 7ac470f
commit 6ba4794
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -6,6 +6,20 @@ A simple memoizer for Go.
 [![Linter](https://goreportcard.com/badge/github.com/LightningDev1/go-memoizer?style=flat-square)](https://goreportcard.com/report/github.com/LightningDev1/go-memoizer)
 [![Build status](https://github.com/LightningDev1/go-memoizer/actions/workflows/ci.yml/badge.svg)](https://github.com/LightningDev1/go-memoizer/actions)
 
+```go
+func expensiveFunction() *any {
+    // ...
+}
+
+var memoizer = memoizer.NewMemoizer(expensiveFunction, 10*time.Second)
+
+for i := 0; i < 50; i++ {
+    value, err := memoizer.Get()
+
+    // ...
+}
+```
+
 ## Installation
 
 ```bash
@@ -14,4 +28,4 @@ go get github.com/LightningDev1/go-memoizer
 
 ## Usage
 
-See [config example](./examples/config/main.go) for an example.
+See [config example](./examples/config/main.go) for a complete example program.