From ec180472a4b9fc0f5754b00cd1461688c4af49d7 Mon Sep 17 00:00:00 2001 From: Michael Gasch Date: Tue, 8 Feb 2022 16:33:39 +0100 Subject: [PATCH] docs: Update README Closes: #32 Signed-off-by: Michael Gasch --- README.md | 4 ++++ sharded/README.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 811d6c7..ae04816 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ version](https://img.shields.io/github/go-mod/go-version/embano1/memlog)](https: An easy to use, lightweight, thread-safe and append-only in-memory data structure modeled as a *Log*. +The `Log` also serves as an abstraction and building block. See +[`sharded.Log`](./sharded/README.md) for an implementation of a *sharded* +variant of `memlog.Log`. + ❌ Note: this package is not about providing an in-memory `logging` library. To read more about the ideas behind `memlog` please see ["The Log: What every software engineer should know about real-time data's unifying diff --git a/sharded/README.md b/sharded/README.md index f15ffc3..f4de9f4 100644 --- a/sharded/README.md +++ b/sharded/README.md @@ -14,7 +14,7 @@ The `Read()` and `Write()` methods accept a sharding `key` to distribute the `Records` based on a (configurable) sharding strategy. Unless specified otherwise, the default sharding strategy uses Golang's -[`fnv.New32a`](https://pkg.go.dev/hash/fnv#New32a) to retrieve a hash and find +[`fnv.New32a`](https://pkg.go.dev/hash/fnv#New32a) to retrieve a *hash* and find the corresponding `Shard` using a *modulo* operation based on the number of (configurable) `Shards` in the `Log`.