docs

pat-dill · May 18, 2020 · 66fba09 · 66fba09
1 parent 90422c3
commit 66fba09
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -2,12 +2,10 @@
 
 **Roblox Requests** brings user-friendly HTTP to Roblox with no need for the manual labor of HttpService.
 
----
-
 With Requests you can send robust, human-readable HTTP requests without ever having to deal with the underlying HttpService.
 No more manual query strings or encoding POST data.
 
-The Power of Roblox Requests:
+#### The Power of Roblox Requests:
 
 ```lua
 local r = http.get("https://api.github.com/orgs/Roblox/repos")
@@ -29,7 +27,7 @@ print(r.headers["x-ratelimit-remaining"])
 
 Roblox Requests will bring simple support for all internet resources to your game.
 
-## Roblox Requests Features
+## Features
 
 - Sessions with Cookie Persistence
 - Default Headers, URL prefixes
@@ -41,4 +39,6 @@ Roblox Requests will bring simple support for all internet resources to your gam
 - Global/Per-Session Ratelimiting
 
 
+Roblox Requests was inspired by the well known [Python Requests](https://2.python-requests.org/en/master/) library.
+
 [In this documentation](https://jpatrickdill.github.io/roblox-requests/guide/installation/) you'll find step-by-step instructions to get the most out of Roblox Requests.
diff --git a/docs/changes.md b/docs/changes.md
diff --git a/docs/guide/quickstart.md b/docs/guide/quickstart.md
@@ -88,7 +88,7 @@ print(r.headers["Last-Modified"])
 -- Wed, 08 Oct 2014 23:28:44 GMT
 ```
 
-This dictionary, however, is special. HTTP headers are case-insensitive, so you can access them however you like:
+HTTP headers are case-insensitive, so you can access them however you like:
 
 ```lua
 print(r.headers["Last-Modified"])

diff --git a/docs/img/with.gif b/docs/img/with.gif
diff --git a/docs/img/without.gif b/docs/img/without.gif
diff --git a/docs/index.md b/docs/index.md
@@ -2,12 +2,10 @@
 
 **Roblox Requests** brings user-friendly HTTP to Roblox with no need for the manual labor of HttpService.
 
----
-
 With Requests you can send robust, human-readable HTTP requests without ever having to deal with the underlying HttpService.
 No more manual query strings or encoding POST data.
 
-The Power of Roblox Requests:
+#### The Power of Roblox Requests:
 
 ```lua
 local r = http.get("https://api.github.com/orgs/Roblox/repos")
@@ -29,7 +27,7 @@ print(r.headers["x-ratelimit-remaining"])
 
 Roblox Requests will bring simple support for all internet resources to your game.
 
-## Roblox Requests Features
+## Features
 
 - Sessions with Cookie Persistence
 - Default Headers, URL prefixes

diff --git a/example.lua b/example.lua
@@ -0,0 +1,8 @@
+local HttpService = game:GetService("HttpService")
+
+local body = HttpService:JSONEncode({cookies = "milk"})
+local r = HttpService:RequestAsync({Url = "https://httpbin.org/put", Method="PUT", Body=body})
+
+if r.Success then
+        data = HttpService:JSONDecode(r.Body)
+end
diff --git a/http/init.lua b/http/init.lua
@@ -14,7 +14,7 @@ local RateLimiter = require(Src.ratelimit)
 
 local http = {}
 
-http.VERSION = "0.2.0"
+http.VERSION = "0.2.1"
 
 http.Request = Request.new
 http.Session = Session.new

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -18,7 +18,6 @@ plugins:
 
 nav:
   - Home: index.md
-  - Release Notes: changes.md
   - Guide:
     - Installation: guide/installation.md
     - Quickstart: guide/quickstart.md
@@ -27,4 +26,4 @@ nav:
 
 
 extra:
-  version: 0.2.0
+  version: 0.2.1