From 9e86c0e1a39a930d9c335aa9bab5897ee3a25795 Mon Sep 17 00:00:00 2001 From: Ari Seyhun Date: Tue, 1 Oct 2024 21:15:43 +0800 Subject: [PATCH] docs: add getting help section to README.md --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 612b85e..2414ba4 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,11 @@ Kameo is a Rust library to build fault-tolerant async actors in Rust. ## Feature highlights -* Async Rust: tokio task per actor -* Supervision: link actors together -* Remote messaging: message actors between nodes -* Panic safe: gracefully handled panics -* Back pressure: supports bounded & unbounded mpsc messaging +* **Async Rust**: tokio task per actor +* **Supervision**: link actors together +* **Remote messaging**: message actors between nodes +* **Panic safe**: gracefully handled panics +* **Back pressure**: supports bounded & unbounded mpsc messaging ## Reasons to use Kameo @@ -71,6 +71,11 @@ let count = actor_ref.ask(Inc { amount: 42 }).send().await?; assert_eq!(count, 42); ``` +## Getting Help + +The kameo book provides a great overview of core concepts in kameo. +If you'd like to reach out, feel free to open an issue or discussion, or join the discord server – [https://discord.gg/GMX4DV9fbk](https://discord.gg/GMX4DV9fbk). + ## Contributing Contributions are welcome! Feel free to submit pull requests, create issues, or suggest improvements.