document defaults for securely storing api tokens

atmos · Jan 13, 2015 · bd1596a · bd1596a
1 parent ff7941c
commit bd1596a
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -53,9 +53,14 @@ use Warden::Manager do |config|
                                              :client_secret => 'barfoo',
                                              :scope         => 'user,repo',
                                              :redirect_uri  => '/admin/oauth/callback' }
+
+  config.serialize_from_session { |key| Warden::GitHub::Verifier.load(key) }
+  config.serialize_into_session { |user| Warden::GitHub::Verifier.dump(user) }
 end
 ```
 
+The two serialization methods store the API token in the session securely via the `WARDEN_GITHUB_VERIFIER_SECRET` environmental variable.
+
 ### Parameters
 
 The config parameters and their defaults are listed below.