Updated README

README.md

@@ -4,16 +4,19 @@ An example of using Openmaize, an authentication library, in a Phoenix web
 application.
 
 To see how Openmaize is called, see the `config/dev.exs` and `web/router.ex`
-files.
+files. In addition, see the `web/controllers/admin_controller.ex` file
+and the login and login_form templates to see how the login GET request
+is handled. It is not necessary to write any logic for logging in and out,
+as that is handled by Openmaize.
 
 In this example, Openmaize is called for every connection and handles the
 authentication of users using Json Web Tokens (JWTs). It also handles the
 login and logout of users.
 
 Openmaize uses roles to offer finer-grained protection, and so the user
 model needs to have a `role` entry, as well as `id` and `name`. The "admin"
-role is allowed complete access to anywhere on the site. In addition, if a
-role's path is followed by an id, other users' pages can be viewed, but not
+role is allowed complete access to anywhere on the site. There is also an
+option to protect pages with ids so that other users' pages can be viewed, but not
 edited. So, in this example, harry can view dick's page, but he is not
 allowed to edit it. See the `config/dev.exs` file for an example of how
 to configure role protection.

config/dev.exs

@@ -40,7 +40,7 @@ config :openmaize,
   crypto: :bcrypt,
   login_dir: "admin",
   redirect_pages: %{"admin" => "/admin", "user" => "/users", nil => "/"},
-  protected: %{"/admin" => [], "/users" => ["user"]},
+  protected: %{"/admin" => [], "/users" => ["user"], "/users/:id" => ["user"]},
   storage_method: "cookie",
   secret_key: "you will never guess",
   token_validity: 600

config/test.exs

@@ -25,7 +25,7 @@ config :openmaize,
   crypto: :bcrypt,
   login_dir: "admin",
   redirect_pages: %{"admin" => "/admin", "user" => "/users", nil => "/"},
-  protected: %{"/admin" => [], "/users" => ["user"]},
+  protected: %{"/admin" => [], "/users" => ["user"], "/users/:id" => ["user"]},
   storage_method: "cookie",
   secret_key: "you will never guess",
   token_validity: 600