Permalink
Browse files

some more docs

  • Loading branch information...
1 parent d3e9958 commit 9a5c838eef159fc9cb7d851955ffbeed644572b6 James A. Rosen committed Sep 5, 2011
Showing with 10 additions and 3 deletions.
  1. +10 −3 README.md
View
@@ -2,8 +2,10 @@
Billfold provides backend Rails support for OmniAuth. Specifically, it
routes `/auth/:provider/callback` to
-`Billfold::IdentitiesController#update_or_create!`, which handles
-identity management.
+`Billfold::IdentitiesController#update_or_create`, which handles
+updating and creating user identities from OmniAuth hashes. It also
+provides `GET /identities` and `DELETE /identities/:id` for users to manage
+the identities attached to their account.
### Requirements
@@ -45,4 +47,9 @@ for your classes, you can, but you have to tell Billfold. You can do that like
so:
Billfold.user_class_name = 'My::User'
- Billfold.identity_class_name = 'My::UserIdentity'
+ Billfold.identity_class_name = 'My::UserIdentity'
+
+#### Internationalization
+
+See `config/locales/en.yml` for a list of keys that must be translated to
+make the models, views, and controllers fully internationalized.

0 comments on commit 9a5c838

Please sign in to comment.