Skip to content

Commit

Permalink
Merge pull request #35 from embano1/issue-32
Browse files Browse the repository at this point in the history
docs: Update README
  • Loading branch information
Michael Gasch committed Feb 8, 2022
2 parents 43b8598 + ec18047 commit eea78ea
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion sharded/README.md
Expand Up @@ -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`.

Expand Down

0 comments on commit eea78ea

Please sign in to comment.