From 982ff08f1102b3fe2417f6f64dbaab58548a4326 Mon Sep 17 00:00:00 2001
From: Braydon <xcoolmanxx@gmail.com>
Date: Thu, 1 Jun 2023 01:17:13 -0400
Subject: [PATCH] Update README.md

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6f8710f..dffeb06 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,40 @@
 # LicenseServer
 
-A simple open-source licensing server for your products.
\ No newline at end of file
+A simple open-source licensing server for your products.
+
+## API Reference
+
+### Check License
+
+```http
+  POST /check
+```
+
+#### Body
+
+| Key       | Type     | Description                                    |
+|:----------|:---------|:-----------------------------------------------|
+| `key`     | `string` | **Required**. Your license key                 |
+| `product` | `string` | **Required**. The product the license is for   |
+| `hwid`    | `string` | **Required**. The hardware id of the requester |
+
+## Deployment
+
+### Docker
+
+```bash
+docker run -d -p 7500:7500 -v "$(pwd)/data:/usr/local/app" git.rainnny.club/rainnny/licenseserver:latest  
+```
+
+### Docker Compose
+
+```yml
+version: '3'
+services:
+  app:
+    image: git.rainnny.club/rainnny/licenseserver:latest
+    volumes:
+      - ./data:/usr/local/app
+    ports:
+      - "7500:7500"
+```
\ No newline at end of file