Skip to content

Commit

Permalink
misc: udpate readme
Browse files Browse the repository at this point in the history
Signed-off-by: Anthony Griffon <anthony@griffon.one>
  • Loading branch information
Miaxos committed Jan 11, 2024
1 parent 87f8ce1 commit 48c508c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ without `io-uring`.
The purpose of this library is to have a performant way to send data between
thread when threads are following a `thread per core` architecture.

Thanks to [Glommio](https://github.com/DataDog/glommio/) for the inspiration

## Example

Originally, the library was made when you had multiple thread listening to the
Expand All @@ -38,12 +40,12 @@ like false sharing[^2].

[^2]: An excellent article explaining it: [alic.dev](https://alic.dev/blog/false-sharing).

You can check the code for this example here: WIP
You can check some examples in the tests.

## References

- https://github.com/DataDog/glommio/blob/master/examples/sharding.rs
- https://github.com/bytedance/monoio/issues/213
- [Glommio example on their sharding](https://github.com/DataDog/glommio/blob/master/examples/sharding.rs)
- [The original monoio issue](https://github.com/bytedance/monoio/issues/213)

## License

Expand Down

0 comments on commit 48c508c

Please sign in to comment.