README.md in omniauth-identity-3.0.4 vs README.md in omniauth-identity-3.0.5
- old
+ new
@@ -8,11 +8,11 @@
[](https://opensource.org/licenses/MIT)
[](https://www.codetriage.com/omniauth/omniauth-identity)
[](https://rubygems.org/gems/omniauth-identity)
The OmniAuth Identity gem provides a way for applications to utilize a
-traditional login/password based authentication system without the need
+traditional username/password based authentication system without the need
to give up the simple authentication flow provided by OmniAuth. Identity
is designed on purpose to be as featureless as possible: it provides the
basic construct for user management and then gets out of the way.
## Compatibility
@@ -243,14 +243,34 @@
Note: Be careful when customizing `locate_conditions`. The best way to modify the conditions is
to copy the default value, and then add to the hash. Removing the default condition will almost
always break things!
+## Customizing Other Things
+
+From the code - here are the options we have for you, a couple of which are documented above, and the rest are documented... in the specs we hope!?
+```
+option :fields, %i[name email]
+
+ # Primary Feature Switches:
+option :enable_registration, true # See #other_phase and #request_phase
+option :enable_login, true # See #other_phase
+
+ # Customization Options:
+option :on_login, nil # See #request_phase
+option :on_validation, nil # See #registration_phase
+option :on_registration, nil # See #registration_phase
+option :on_failed_registration, nil # See #registration_phase
+option :locate_conditions, ->(req) { { model.auth_key => req['auth_key'] } }
+```
+
+Please contribute some documentation if you have the gumption! The maintainer's time is limited, and sometimes the authors of PRs with new options don't update the _this_ readme. ðŸ˜
+
## License
MIT License. See LICENSE for details.
## Copyright
-Copyright (c) 2021 OmniAuth-Identity Maintainers
-Copyright (c) 2020 Peter Boling, Andrew Roberts, and Jellybooks Ltd.
-Copyright (c) 2010-2015 Michael Bleigh, and Intridea, Inc.
+* Copyright (c) 2021 OmniAuth-Identity Maintainers
+* Copyright (c) 2020 Peter Boling, Andrew Roberts, and Jellybooks Ltd.
+* Copyright (c) 2010-2015 Michael Bleigh, and Intridea, Inc.