From 85c166f1011c011f26280d84b13a2338aaa734ac Mon Sep 17 00:00:00 2001
From: Aneurin Barker Snook <a@aneur.in>
Date: Fri, 21 Jun 2024 21:54:44 +0100
Subject: [PATCH] add readme for each package

---
 README.md   | 33 +++++++++++++++++++++++++++++++++
 registry.go | 18 +++++++++---------
 2 files changed, 42 insertions(+), 9 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8cc7a74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Go Registry
+
+This package provides a simple registry implementation which allows storing arbitrary values in a memory map.
+
+You can also lock specific keys to prevent them being written, even if no value has yet been set. Locked keys cannot be unlocked.
+
+## Example
+
+```go
+package main
+
+import (
+	"fmt"
+
+	"github.com/annybs/go/registry"
+)
+
+func main() {
+	r := registry.New()
+
+	r.Set("some key", "some text")
+	fmt.Println(r.Get("some key"))
+
+	r.Lock("some key")
+	if err := r.Set("some key", "different text"); err != nil {
+		fmt.Println(err)
+	}
+}
+```
+
+## License
+
+See [LICENSE.md](../LICENSE.md)
diff --git a/registry.go b/registry.go
index 3c48dec..3cb3dd2 100644
--- a/registry.go
+++ b/registry.go
@@ -12,41 +12,41 @@ var (
 // Registry is a simple interface allowing untyped common values to be shared across packages.
 // This is particularly useful for resolving import cycles.
 type Registry struct {
-	Data  map[string]any
-	Locks map[string]bool
+	data  map[string]any
+	locks map[string]bool
 }
 
 // Get the value of a key.
 // This function returns nil if no value exists.
 func (reg *Registry) Get(key string) any {
-	return reg.Data[key]
+	return reg.data[key]
 }
 
 // Has checks whether a key is non-nil.
 func (reg *Registry) Has(key string) bool {
-	return reg.Data[key] == nil
+	return reg.data[key] == nil
 }
 
 // Lock a key.
 // This prevents the value being overwritten by Set.
 func (reg *Registry) Lock(key string) {
-	reg.Locks[key] = true
+	reg.locks[key] = true
 }
 
 // Set the value for a key.
 // This function returns an error if the key is locked.
 func (reg *Registry) Set(key string, value any) error {
-	if reg.Locks[key] {
+	if reg.locks[key] {
 		return ErrKeyLocked
 	}
-	reg.Data[key] = value
+	reg.data[key] = value
 	return nil
 }
 
 // New creates a new registry.
 func New() *Registry {
 	return &Registry{
-		Data:  map[string]any{},
-		Locks: map[string]bool{},
+		data:  map[string]any{},
+		locks: map[string]bool{},
 	}
 }