Merge pull request #38 from ubclaunchpad/jacqueschen1/#25-user_comman…

…d_doc Create initial documentation `user` command #25
ubclaunchpad · Oct 11, 2018 · a9f0042 · a9f0042
2 parents 42ad5c9 + 1eff942
commit a9f0042
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/docs/UserCommands.md b/docs/UserCommands.md
@@ -0,0 +1,27 @@
+# User Command Reference
+
+`@rocket user`
+
+## Options to specify input
+
+* `edit`
+  * `--name` NAME
+  * `--email` ADDRESS
+  * `--pos` YOURPOSITION
+  * `--github` YOURREPO
+  * `--major` YOURMAJOR
+  * `--bio` YOURMAJOR
+    * edit properties of your Launch Pad profile
+  * ADMIN or TEAM LEAD only option: `--member` MEMBER_ID
+    * edit properties of another user's Launch Pad profile
+
+* `view` MEMBER_ID
+  * view information about a user
+
+* `help`
+  * outputs options for user commands
+
+## ADMIN only
+
+* `delete` MEMBER_ID
+  * permanently delete member's Launch Pad profile