0.1.0-beta.4

README.md

@@ -4,6 +4,8 @@
 
 A [Flarum](http://flarum.org) extension that allows your to manage every aspect of your users, with style!
 
+This extension allows you to give users strikes for posts if they violate rules. Those strikes are kept and can be viewed at anytime by anyone with permission. This extension also allows your to disable the email registration option, as well as adds age and gender at registration. The user's age and gender is shown on their profile page. You can also manually activate users from the admin interface, or from the users page.
+
 ### Goals
 
 - To make registration more customizable
@@ -26,6 +28,13 @@ composer require reflar/user-management
 
 Then login and enable the extension.
 
+### Developer Guide
+
+You have 2 events to listen for "UserWillBeGivenStrike" as well as "UserGivenStike" which both contain the offending, the user being struck, the strike issuer, and the reason.
+
+You also have the api/strike post route to give a Sumer a strike, /API strike/{userId} get route to get a user's strikes, and /api/strike/{id} delete route to delete the strike.
+
+You can also post to /api/reflar/usermanagement/attributes to set a user's gender and age.
 
 ### To Do
 
@@ -38,6 +47,6 @@ Then login and enable the extension.
 
 ### Links
 
-- [on github](https://github.com/ReFlar/user-managementr)
+- [on github](https://github.com/ReFlar/user-management)
 - [on packagist](https://packagist.org/packages/ReFlar/user-management)
-- [issues](https://github.com/ReFlar/user-management/issues)
+- [issues](https://github.com/ReFlar/user-management/issues)