Skip to content

Commit

Permalink
chore: updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BRAVO68WEB committed Sep 12, 2024
1 parent 952e501 commit 97e3719
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down

0 comments on commit 97e3719

Please sign in to comment.