lookitsatravis/api_guardian

View on GitHub
docs/readme.md

Summary

Maintainability
Test Coverage
# ApiGuardian Documentation

RDoc-style documentation available here:

http://www.rubydoc.info/github/lookitsatravis/api_guardian/master

## Table of Contents

* [Installation](installation/readme.md)
  * [Routing](installation/readme.md#routing)
  * [Models](installation/readme.md#models)
  * [Controllers](installation/readme.md#controllers--such)
    * [Policies](installation/readme.md#policies)
    * [Stores](installation/readme.md#stores)
    * [Serializers](installation/readme.md#serializers)
* [Configuration](configuration/readme.md)
  * [Access Token Expiration](configuration/readme.md#access-token-expiration)
  * [Configuring JWT](configuration/readme.md#configuring-jwt)
  * [Customizing Models/Tables](configuration/readme.md#customizing-modelstables)
* [Registration](registration/readme.md)
  * [Email](registration/readme.md#email)
  * [Third-Party Registration](registration/readme.md#third-party-registration)
    * [Facebook](registration/readme.md#facebook)
    * [Twitter Digits](registration/readme.md#twitter-digits)
* [Authentication](authentication/readme.md)
  * [JSON Web Token Responses](authentication/readme.md#jwt-responses)
  * [Email Authentication](authentication/readme.md#email-authentication)
  * [Third-Party Authentication](authentication/readme#third-party-authentication)
    * [Facebook Authentication](authentication/readme.md#facebook-authentication)
    * [Twitter Digits Authentication](authentication/readme.md#twitter-digits-authentication)
  * [Guest Authentication](authentication/readme.md#guest-authentication)
  * [Two-Factor Authentication](authentication/readme.md#two-factor-authentication)
  * [Password Reset](authentication/readme.md#password-reset)
* [Authorization](authorization/readme.md)
  * [Roles & Permissions](authorization/readme.md#roles--permissions)
  * [Users](authorization/readme.md#users)
  * [Policies](authorization/readme.md#policies)

### To Complete

* Password reset

---

ApiGuardian is copyright © 2015-2017 Travis Vignon. It is free software, and may be
redistributed under the terms specified in the [`MIT-LICENSE`](https://github.com/lookitsatravis/api_guardian/blob/master/MIT-LICENSE) file.