From 4d6138322d2d5fc29b53f6a7b5e73f47b4bc16e2 Mon Sep 17 00:00:00 2001
From: David Crammer <dcrammer777@gmail.com>
Date: Tue, 14 Nov 2023 21:55:22 -0700
Subject: [PATCH] Update readme

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/README.md b/README.md
index 419f940..5a09a88 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,41 @@
 # service-authentication
+
+This is a service that provides authentication for the other services in the system.
+
+### Features:
+
+- Registration
+- Login
+- Password Reset
+- Webhooks
+- JWTs
+  - Token Refresh
+- oAuth
+  - Configurable token providers
+  - Linking oAuth to user profile
+- MFA
+  - SMS-based, OTPs
+  - Authenticator apps
+- Rate limiting
+- CAPTCHA
+- Audit trail
+- Roles and caps
+
+---
+
+## Reference
+
+## Endpoints
+
+### POST /register
+
+Register a new user.
+
+#### Request
+
+```json
+{
+  "email": "example@gmail.com", // required
+  "password": "password123" // optional, if not provided, a random password will be generated
+}
+```