Adding some docs

README.md

@@ -37,6 +37,7 @@ Front Page|Post
   - Can ban and unban users from communities and the site.
 - Clean, mobile-friendly interface.
 - i18n / internationalization support.
+- NSFW post / community support.
 - High performance.
   - Server is written in rust.
   - Front end is `~80kB` gzipped.

docs/api.md

@@ -28,7 +28,7 @@ A simple test command:
 
 ## API
 ### List
-`Login, Register, CreateCommunity, CreatePost, ListCommunities, ListCategories, GetPost, GetCommunity, CreateComment, EditComment, SaveComment, CreateCommentLike, GetPosts, CreatePostLike, EditPost, SavePost, EditCommunity, FollowCommunity, GetFollowedCommunities, GetUserDetails, GetReplies, GetModlog, BanFromCommunity, AddModToCommunity, CreateSite, EditSite, GetSite, AddAdmin, BanUser, Search, MarkAllAsRead`
+`Login, Register, CreateCommunity, CreatePost, ListCommunities, ListCategories, GetPost, GetCommunity, CreateComment, EditComment, SaveComment, CreateCommentLike, GetPosts, CreatePostLike, EditPost, SavePost, EditCommunity, FollowCommunity, GetFollowedCommunities, GetUserDetails, GetReplies, GetModlog, BanFromCommunity, AddModToCommunity, CreateSite, EditSite, GetSite, AddAdmin, BanUser, Search, MarkAllAsRead, SaveUserSettings`
 
 ### Sort Types
 These go wherever there is a `sort` field.
@@ -109,7 +109,21 @@ Only the first user will be able to be the admin.
   posts: Vec<PostView>,
 }
 ```
-
+#### Save User Settings
+##### Request
+```rust
+{
+  show_nsfw: bool,
+  auth: String,
+}
+```
+##### Response
+```rust
+{
+  op: String,
+  jwt: String
+}
+```
 #### Get Replies / Inbox
 ##### Request
 ```rust