1
0
Fork 0
mirror of https://github.com/simi/omniauth-facebook.git synced 2022-11-09 12:32:45 -05:00

update readme to reflect available options for display option

This commit is contained in:
Mark Dodwell 2012-05-05 00:50:10 -07:00
parent bd4aa5c315
commit cd715c616e

View file

@ -35,8 +35,8 @@ end
You can configure several options, which you pass in to the `provider` method via a `Hash`:
* `scope`: A comma-separated list of permissions you want to request from the user. See the Facebook docs for a full list of available permissions: http://developers.facebook.com/docs/reference/api/permissions. Default: `email`
* `display`: The display context to show the authentication page. Options are: `page`, `popup`, `iframe`, `touch` and `wap`. Read the Facebook docs for more details: http://developers.facebook.com/docs/reference/dialogs#display. Default: `page`
* `secure_image_url`: Set to `true` to use https for the avatar image url returned in the authentication hash. Default is `false`.
* `display`: The display context to show the authentication page. Options are: `page`, `popup` and `touch`. Read the Facebook docs for more details: https://developers.facebook.com/docs/reference/dialogs/oauth/. Default: `page`
* `secure_image_url`: Set to `true` to use https for the avatar image url returned in the auth hash. Default is `false`.
* `image_size`: Set the size for the returned image url in the auth hash. Valid options are `square` (50x50), `small` (50 pixels wide, variable height), `normal` (100 pixels wide, variable height), or `large` (about 200 pixels wide, variable height). Default is `square` (50x50).
For example, to request `email`, `user_birthday` and `read_stream` permissions and display the authentication page in a popup window: