readme: document new things

Author: RaphaelIT7

README.md

@@ -10,89 +10,125 @@ TODO:
 - Add a Post-routing handler and function
 
 # Functions
+
+## Main Functions
+
+#### HttpServer HttpServer:Create()
+Creates a new HTTPServer.  
+
+#### HttpServer:Destroy(HttpServer server)
+Destroys the given http server.  
+
 ## Basic Functions
-#### httpserver.Start(String IP, Number Port)
+
+#### HttpServer:Start(String IP, Number Port)
 This will start or restart the HTTP Server, and it will listen on the given address + port.  
-NOTE: If a Method function was called like httpserver.Get after httpserver.Start was called, you need to call httpserver.Start again!
-#### httpserver.Stop()
+NOTE: If a Method function was called like HttpServer:Get after HttpServer:Start was called, you need to call HttpServer:Start again!
+#### HttpServer:Stop()
 This stops the HTTP Server.
-#### (internal function!) httpserver.Think()
-This is internally used to manage all requests and to call all functions needed. (Never call this yourself.)
+#### (internal function) HttpServer:Think()
+This is internally used to manage all requests and to call all functions needed.
 
 ## Method Functions
 All Method functions add a listener for the given path and the given method, like this:
 ```lua
-httpserver.Get("/public", function(_, response) 
-  print("Public GET request") 
+HttpServer:Get("/public", function(_, response)
+  print("Public GET request")
   response.SetContent("You sent a GET request to a public site.", "text/plain")
 end, false)
 
-httpserver.Get("/private", function(_, response) 
-  print("Private GET request") 
+HttpServer:Get("/private", function(_, response)
+  print("Private GET request")
   response.SetContent("You sent a GET request to a private site.", "text/plain")
 end, true)
 ```
 
 If you enable the IP Whitelist, only requests sent by connected players are processed.
 
-#### httpserver.Get(String path, function (Request, Response), bool ipwhitelist)
-#### httpserver.Put(String path, function (Request, Response), bool ipwhitelist)
-#### httpserver.Post(String path, function (Request, Response), bool ipwhitelist)
-#### httpserver.Patch(String path, function (Request, Response), bool ipwhitelist)
-#### httpserver.Delete(String path, function (Request, Response), bool ipwhitelist)
-#### httpserver.Options(String path, function (Request, Response), bool ipwhitelist)
+#### HttpServer:Get(String path, function (Request, Response), bool ipwhitelist)
+#### HttpServer:Put(String path, function (Request, Response), bool ipwhitelist)
+#### HttpServer:Post(String path, function (Request, Response), bool ipwhitelist)
+#### HttpServer:Patch(String path, function (Request, Response), bool ipwhitelist)
+#### HttpServer:Delete(String path, function (Request, Response), bool ipwhitelist)
+#### HttpServer:Options(String path, function (Request, Response), bool ipwhitelist)
 
 ## Additional Functions
-#### httpserver.IsRunning()
+
+#### bool HttpServer:IsRunning()
 Returns true if the HTTPServer is running.
-#### httpserver.SetTCPnodelay(bool nodelay)
+
+#### HttpServer:SetTCPnodelay(bool nodelay)
 Sets whether a delay should be added to tcp or not.
-#### httpserver.SetReadTimeout(int sec, int usec)
+
+#### HttpServer:SetReadTimeout(int sec, int usec)
 Sets the maximum amount of time before a read times out.
-#### httpserver.SetWriteTimeout(int sec, int usec)
+
+#### HttpServer:SetWriteTimeout(int sec, int usec)
 Sets the maximum amount of time before a write times out.
-#### httpserver.SetPayloadMaxLength(int maxlength)
+
+#### HttpServer:SetPayloadMaxLength(int maxlength)
 Sets the maximum payload length.
-#### httpserver.SetKeepAliveTimeout(int sec)
+
+#### HttpServer:SetKeepAliveTimeout(int sec)
 Sets the maximum time a connection is kept alive.
-#### httpserver.SetKeepAliveMaxCount(int amount)
+
+#### HttpServer:SetKeepAliveMaxCount(int amount)
 Sets the maximum amount of connections that can be kept alive at the same time.
-#### httpserver.SetMountPoint(string path, string folder)
+
+#### HttpServer:SetMountPoint(string path, string folder)
 This mounts the given folder to the given path.
 (You can call this multiple times for the same path to mount multiple folders to it.)
-#### httpserver.RemoveMountPoint(string path)
+
+#### HttpServer:RemoveMountPoint(string path)
 This removes all mounts for the given path.
 
 ## Request
-#### Request.body
+
+#### bool Request.HasHeader(key)
+returns true if the client has the given key in the header.
+
+#### bool Request.HasParam(key)
+returns true if the client has the given key in the parameters.
+
+#### string Request.GetHeader(key)
+returns the value of the given key from the header.
+
+#### string Request:GetParam(key)
+returns the value of the given key from the parameters.
+
+#### string Request:GetBody()
 The body of the HTTP Request.
-#### Request.remote_addr
+
+#### string Request:GetRemoteAddr()
 the IP Address of the Person who sent the HTTP Request
-#### Request.remote_port
+
+#### number Request:GetRemotePort()
 The Port the HTTP request was received from.
-#### Request.local_addr
-#### Request.local_port
-#### Request.method
+
+#### string Request:GetLocalAddr()
+
+#### number Request:GetLocalPort()
+
+#### string Request:GetMethod()
 The HTTP Method that was used like GET or PUT.
-#### Request.authorization_count
-#### Request.content_length
+
+#### number Request:GetAuthorizationCount()
+
+#### number Request:GetContentLength()
 The length of the HTTP Request content.
-#### Request.HasHeader(key)
-returns true if the client has the given key in the header.
-#### Request.HasParam(key)
-returns true if the client has the given key in the parameters.
-#### Request.GetHeader(key)
-returns the value of the given key from the header.
-#### Request.GetParam(key)
-returns the value of the given key from the parameters.
 
 ## Response
-#### Response.SetContent(content, content-type)
+
+#### Response:SetContent(content, content-type)
 Sets the content like this:
 ```lua
 Response.SetContent("Hello World", "text/plain")
 ```
-#### Response.SetRedirect(url, code)
+#### Response:SetRedirect(url, code)
 Redirects one to the given URL and returns the given code.
-#### Response.SetHeader(key, value)
+
+#### Response:SetHeader(key, value)
 Sets the given value for the given key in the header.
+
+#### table Response:GetTable()
+Returns the lua table.