8.x 1.x readme

README.md

-
-Simple User Management Module Readme
---------------------------------------
+# Simple User Management
 
 This module provides a way to let clients easily approve users as well as grant
 them particular roles such as site editors assigning editor role to other new
@@ -8,44 +6,58 @@ users (but avoiding editors granting or gaining administrator access). The
 module provides quick access operations from the people list to approve and
 delegate roles.
 
-It uses the excellent Role Delegation module under the hood for delegating roles
-and provides it's own simple interface for approving users without the need
-for the 'administer users' permission.
+It uses the excellent Role Delegation module under the hood for delegating
+roles and provides it's own simple interface for approving users without
+the need for the 'administer users' permission.
+
 
-Example use cases
------------------
+## Example use cases
 
 You want to provide a very simple interface to let your client manage site
 editors and authors but want to avoid your clients gaining administrator access.
 You may have opened up registration with approval and want your client to be
 able to approve users (eg, a new colleague) and grant them a particular role.
 
-Installation
-------------
 
-To install this module:
+## Requirements
+
+This module requires the following module:
+
+- [Role Delegation](https://www.drupal.org/project/role_delegation)
+
+
+## Installation
+
+Install as you would normally install a contributed Drupal module. For further
+information, see
+[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
 
-* place it in your modules folder and enable it on the
-modules page.
-* grant the desired role (such as 'editor') 'view user information' permission
-  via admin > people > permissions.
-* grant the desired role (such as 'editor') the desired role delegation
+
+## Configuration
+
+
+- Place it in your modules folder and enable it on the modules page.
+- Grant the desired role (such as 'editor') 'view user information' permission
+  via `admin > people > permissions`.
+- Grant the desired role (such as 'editor') the desired role delegation
   permissions such as delegating the 'editor' and 'author' role, avoiding
   allowing delegation of the administrator role to keep your site safe.
-* optionally grant the 'create user accounts' permission (eg, to 'editor') (otherwise
-  users must register via '/user/register' and then the editor can activate and
-  grant the role).
-* go to admin > structure > views > 'People' (/admin/structure/views/view/user_admin_people) and set the permission of the view to be
-  'view user information' and save the view.
-* optionally add a quicklink or add the admin > people to a menu location that
-  your non-admin role (such as 'editor') can access
+- Optionally grant the 'create user accounts' permission (eg, to 'editor')
+  (otherwise users must register via '/user/register' and then the editor
+  can activate and grant the role).
+- Go to `admin > structure > views > 'People'`
+  (/admin/structure/views/view/user_admin_people) and set the permission of
+  the view to be 'view user information' and save the view.
+- Optionally add a quicklink or add the `admin > people` to a menu location
+  that your non-admin role (such as 'editor') can access
 
-Feedback on this module
------------------------
+
+## Feedback on this module
 
 Please add issues with feature requests as well as feedback on the existing
 functionality.
 
-Supporting organizations
-------------------------
-Development and maintenance of this module is sponsored by Fat Beehive
+
+## Supporting organizations
+
+Development and maintenance of this module is sponsored by [Fat Beehive](https://www.drupal.org/fat-beehive)