docs: 📝 exposed urls

.github/workflows/rust.yml

@@ -0,0 +1,22 @@
+name: Rust Build && Test
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build
+      run: cargo build --verbose
+    - name: Run tests
+      run: cargo test --verbose

README.md

@@ -1,2 +1,24 @@
 # acapair_chat_api
 Acapair Chat API
+
+[![Rust Build && Test](https://github.com/Acapair/acapair_chat_api/actions/workflows/rust.yml/badge.svg)](https://github.com/Acapair/acapair_chat_api/actions/workflows/rust.yml)
+
+
+## Exposed URLs
+> ':' means they are variable.
+
+Alive Ping(get): "/"
+
+---
+
+Send Message(post): "/send"
+
+| Body Fields    | Example Values |
+| -------- | ------- |
+| "room_id"  | "Tahinli's Room -1"    |
+| "username" | "Tahinli"     |
+| "message"    | "Hi!"    |
+
+---
+
+Receive Message(get): "/receive/:room_id"