Update docs

i-lateral · Feb 22, 2018 · e4b4ff8 · e4b4ff8
1 parent 9b7a9dd
commit e4b4ff8
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-Silverstripe Users
-==================
+# Silverstripe Users
 
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/i-lateral/silverstripe-users/badges/quality-score.png?b=1)](https://scrutinizer-ci.com/g/i-lateral/silverstripe-users/?branch=1)
 
@@ -10,3 +9,15 @@ This module is intended to provide a very bare bones profile management
 system that can be easily expanded using extension classes and templates
 to allow users to build profile editing into any system they want to
 use.
+
+## Installation
+
+```
+composer require i-lateral/silverstripe-users
+```
+
+See docs/en/Installing.md
+
+## More info
+
+View all documentation at: docs/en/Index.md
diff --git a/docs/Examples.md → docs/en/Examples.md b/docs/Examples.md → docs/en/Examples.md
diff --git a/docs/en/Index.md b/docs/en/Index.md
@@ -0,0 +1,10 @@
+# The users account management module for SilverStripe
+
+This module allows users to register for an account and manage their 
+account settings via a front end controller.
+
+You find out more info about this module in the following docs:
+
+* [Insalling](Installing.md)
+* [Usage](Usage.md)
+* [Examples](Examples.md)
diff --git a/docs/en/Installing.md b/docs/en/Installing.md
@@ -0,0 +1,13 @@
+# Installation
+
+Then in the root of your project run:
+
+```sh
+composer require i-lateral/silverstripe-users`
+```
+
+Then rebuild your database by visiting `dev/build`. This will add the required database columns and tables for the module to function, and refresh the configuration manifest.
+
+## Usage
+
+See for more info on using this module, [see the docs](Usage.md)
diff --git a/docs/Usage.md → docs/en/Usage.md b/docs/Usage.md → docs/en/Usage.md