From 73dcb5beb1f6a32246a25d8ae40b1795d6740a5a Mon Sep 17 00:00:00 2001 From: Aaron Date: Sun, 22 Feb 2015 22:27:45 -0800 Subject: [PATCH] Add a few updates to documentation. --- README.md | 7 +++---- auth/README.md | 4 +++- confirm/README.md | 1 + expire/README.md | 1 + lock/README.md | 1 + recover/README.md | 1 + register/README.md | 1 + remember/README.md | 3 +++ 8 files changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c7f5af9..7a5e728 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,10 @@ Each module can be turned on simply by importing it and the side-effects take ca Name | Import Path | Description ---------------|-----------------------------------------------------------------------------------------------------|------------ -Core | [gopkg.in/authboss.v0](https://github.com/go-authboss/authboss) | The necessities for authentication, module system etc. +Core | [gopkg.in/authboss.v0](https://github.com/go-authboss/authboss) | Support for the modular system, constants, helpers. Register | [gopkg.in/authboss.v0/register](https://github.com/go-authboss/authboss/tree/master/register) | Provides a registration section for users. Confirm | [gopkg.in/authboss.v0/confirm](https://github.com/go-authboss/authboss/tree/master/confirm) | Sends an e-mail verification before allowing users to log in. Recover | [gopkg.in/authboss.v0/recover](https://github.com/go-authboss/authboss/tree/master/recover) | Allows for password resets via e-mail. -Remember | [gopkg.in/authboss.v0/remember](https://github.com/go-authboss/authboss/tree/master/remember) | Half-authed accounts using a generated token. +Remember | [gopkg.in/authboss.v0/remember](https://github.com/go-authboss/authboss/tree/master/remember) | Persisting login sessions past session expiry. Lock | [gopkg.in/authboss.v0/lock](https://github.com/go-authboss/authboss/tree/master/lock) | Locks user accounts after N authentication failures in M time. -Expire | [gopkg.in/authboss.v0/expire](https://github.com/go-authboss/authboss/tree/master/expire) | Expires user sessions after a certain period of time. -Validate | [gopkg.in/authboss.v0/validate](https://github.com/go-authboss/authboss/tree/master/validate) | Username, Email and Password format validations. +Expire | [gopkg.in/authboss.v0/expire](https://github.com/go-authboss/authboss/tree/master/expire) | Expires user sessions after a certain period of inactivity. diff --git a/auth/README.md b/auth/README.md index 63e0e9f..f22372d 100644 --- a/auth/README.md +++ b/auth/README.md @@ -1,2 +1,4 @@ Auth -========= \ No newline at end of file +========= + +Auth authorizes users using credentials. \ No newline at end of file diff --git a/confirm/README.md b/confirm/README.md index c4b5174..f8f7e80 100644 --- a/confirm/README.md +++ b/confirm/README.md @@ -1,3 +1,4 @@ Confirm ========= +Confirm ensures registered users must confirm via e-mail before being an active user. \ No newline at end of file diff --git a/expire/README.md b/expire/README.md index b95476c..0efea39 100644 --- a/expire/README.md +++ b/expire/README.md @@ -1,3 +1,4 @@ Expire ========= +Expires user's active sessions if they have not taken action for a configurable amount of time. \ No newline at end of file diff --git a/lock/README.md b/lock/README.md index f5fe038..2c7ed5f 100644 --- a/lock/README.md +++ b/lock/README.md @@ -1,3 +1,4 @@ Lock ========= +Locks user accounts that have failed authentication a number of times. \ No newline at end of file diff --git a/recover/README.md b/recover/README.md index bdea906..b5967eb 100644 --- a/recover/README.md +++ b/recover/README.md @@ -1,3 +1,4 @@ Recover ========= +Recover implements password recovery mechanisms. \ No newline at end of file diff --git a/register/README.md b/register/README.md index 9b666ae..adda0dd 100644 --- a/register/README.md +++ b/register/README.md @@ -1,3 +1,4 @@ Register ========= +Register allows users to register a new user account. \ No newline at end of file diff --git a/remember/README.md b/remember/README.md index e000d49..e138fb1 100644 --- a/remember/README.md +++ b/remember/README.md @@ -1,3 +1,6 @@ Remember ========= +Remember module implements remebering users past the session cookie expiry. Also +ensures that remembered users are marked as "half-authed" to easily allow denying +of sensitive information until fully authed. \ No newline at end of file