Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README #35

Merged
merged 1 commit into from
Feb 8, 2022
Merged

docs: Update README #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
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