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

Jump to bottom

chore: updated docs #4

Merged
merged 2 commits into from
Sep 12, 2024
Merged

chore: updated docs #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97e3719
chore: updated docs
BRAVO68WEB Sep 12, 2024
213234a
Merge branch 'main' into doc/readme
BRAVO68WEB Sep 12, 2024
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
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
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
Loading