From fff5e1a1a0cacbccd8d4364a5ad94f1fe3c25bb2 Mon Sep 17 00:00:00 2001
From: 0xf8 <0xf8.dev@proton.me>
Date: Wed, 21 Jun 2023 04:32:19 -0400
Subject: [PATCH] Improve readme

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

diff --git a/README.md b/README.md
index b105bd8..f236285 100644
--- a/README.md
+++ b/README.md
@@ -19,3 +19,37 @@ $ sqlx db create
 $ sqlx migrate run
 ```
 
+# Yggdrasil Server
+- Run convenience script `./yggdrasil`
+- OR `DATABASE_URL=<url> cargo run --bin yggdrasil`
+
+# Database tool (dbtool)
+- Run convenience script `./dbtool`
+- OR `DATABASE_URL=<url> cargo run --bin dbtool`
+
+## Available commands
+- `add-account`: Creates a new account
+    - Email (`email@example.com`)
+    - Language (`en-us`)
+    - Country (`US`)
+
+- `add-profile`: Creates a new profile for an account
+    - Email (`email@example.com`) (Must match existing account)
+    - Username (`EpicMinecrafter4000`)
+
+- `attach-profile`: Attaches a specific profile to an account
+    - Account ID (`5`) (Must match existing account)
+    - Profile ID (`3`) (Must match existing profile)
+
+- `del-account`: Deletes an account
+    - Account ID (`5`)
+
+- `del-profile`: Deletes a profile
+    - Profile ID (`3`)
+
+- `search`: Search for a specific profile or account
+    - Search type (`account-id`, `profile-id`, `email` (account), `name` (profile), `uuid` (profile))
+    - Query (Can have multiple)
+
+- `dump`: Dumps a table in the database (Mostly for debug)
+    - Table name (`accounts`, `profiles`, `sessions`, `tokens`)
\ No newline at end of file