docs for server-api

server/Cargo.toml

@@ -1,10 +1,8 @@
 [package]
-name = "api"
+name = "freechat-api"
 version = "0.1.0"
 authors = ["shockrahwow <alejandros714@protonmail.com>"]
-edition = "2018"
+edition = "2019"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 rocket = "0.4.2"

server/readme.md

@@ -1,3 +1,18 @@
 # API
 
-To serve clients data about the server they are joined into
+This api operates on a per instance/world basis ergo we only concern ourselves with the same concerns as a typical server.
+
+# Language
+
+* Instance/World/Realm are going to be used interchangably
+
+# Endpoints::World
+
+* auth - verifies a user is in fact part of that instance/world in some way
+
+* register - base for creating a new user registered through this domain
+
+* unlist - remove user from that domain's registry
+
+* join - adds user to a member registry in that world; for users that come from other hubs
+