From 97e3719cc1b07622852c254ad5ca09ea702208b3 Mon Sep 17 00:00:00 2001 From: bravo68web Date: Thu, 12 Sep 2024 11:42:37 +0000 Subject: [PATCH] chore: updated docs --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ae6b93..91ad329 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ### Introduction -This is a service that provides authentication between services. It is built using Rust and Redis. +This is a service that provides authentication between services. It is a simple service that allows services to register and authenticate with each other. The service is designed to be fault-tolerant and scalable. ### 🦄 Prerequisites @@ -24,6 +24,14 @@ NUM_WORKERS= LOG_LEVEL= ``` +### 🎁 Crates + +| Name | Description | Visit | +|------|-------------|-------| +| http | REST API Server for adding and listing nodes | [Open](./crates/http/) | +| attendance | Redis Pub/Sub Server which takes attendance of all connected nodes | [Open](./crates/attendance/) | +| pinger | Redis Pub/Sub Server which help to ping all connected nodes | [Open](./crates/pinger/) | + ### 🚀 Usage ```bash