Skip to content

Commit 217ff7f

Browse files
committed
docs: reorganize README to enhance clarity and update tech stack details
1 parent 68097e3 commit 217ff7f

1 file changed

Lines changed: 21 additions & 24 deletions

File tree

README.md

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,6 @@ OpsLedger provides a single source of truth for all changes made to your infrast
2020

2121
## Features
2222

23-
### Real-time Updates
24-
The change log updates live across all open browser sessions without any page refresh — powered by **Server-Sent Events (SSE)**:
25-
- **Instant propagation** — when any user registers, edits, or deletes a change, every connected client sees the update immediately
26-
- **Connection status indicator** — a green pulsing dot in the nav bar shows the live connection; turns amber with "Reconnecting" if the stream drops
27-
- **Exponential backoff reconnection** — the client automatically reconnects with 1s → 2s → 4s … capped at 30s backoff
28-
- **Smart fallback** — when the SSE stream is offline, the UI falls back to a manual refetch after mutations so data stays consistent
29-
- **JWT-authenticated stream** — the `/api/events` endpoint validates the session token; API keys are intentionally not accepted on the SSE endpoint to avoid long-lived credentials appearing in server logs
30-
3123
### Change Management
3224
- **Register Changes** - Log infrastructure, deployment, and configuration changes with rich metadata including system, environment, change type, and detailed descriptions
3325
- **Real-time Filtering** - Filter changes by system, environment, user, change type, and time range
@@ -51,23 +43,9 @@ The change log updates live across all open browser sessions without any page re
5143
- API key lifecycle management
5244
- Audit log for security tracking
5345

54-
## Tech Stack
55-
56-
### Frontend
57-
- **React 18** with TypeScript
58-
- **Vite** - Build tool and dev server
59-
- **Tailwind CSS** - Styling
60-
- **shadcn/ui** - Component library (Radix UI primitives)
61-
- **React Router DOM** - Client-side routing
62-
- **TanStack Query** - Server state management
63-
- **React Hook Form + Zod** - Form handling and validation
64-
- **Recharts** - Data visualization
46+
### Real-time Updates
47+
The change log updates live across all open browser sessions without any page refresh — powered by **Server-Sent Events (SSE)**
6548

66-
### Backend
67-
- **Go** with the Echo framework
68-
- **MySQL** database
69-
- **JWT** for session authentication
70-
- **SHA-256** for API key hashing
7149

7250
## Use Cases
7351

@@ -205,6 +183,25 @@ The API supports two authentication methods:
205183
X-API-Key: <your_api_key>
206184
```
207185

186+
## Tech Stack
187+
188+
### Frontend
189+
- **React 18** with TypeScript
190+
- **Vite** - Build tool and dev server
191+
- **Tailwind CSS** - Styling
192+
- **shadcn/ui** - Component library (Radix UI primitives)
193+
- **React Router DOM** - Client-side routing
194+
- **TanStack Query** - Server state management
195+
- **React Hook Form + Zod** - Form handling and validation
196+
- **Recharts** - Data visualization
197+
198+
### Backend
199+
- **Go** with the Echo framework
200+
- **MySQL** database
201+
- **JWT** for session authentication
202+
- **SHA-256** for API key hashing
203+
204+
208205
## Project Structure
209206

210207
```

0 commit comments

Comments
 (0)