Skip to content

Commit dd2c7b3

Browse files
authored
Update README.md
1 parent e7194b2 commit dd2c7b3

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,26 @@ Note: Be careful when customizing `locate_conditions`. The best way to modify t
245245
to copy the default value, and then add to the hash. Removing the default condition will almost
246246
always break things!
247247

248+
## Customizing Other Things
249+
250+
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!?
251+
```
252+
option :fields, %i[name email]
253+
254+
# Primary Feature Switches:
255+
option :enable_registration, true # See #other_phase and #request_phase
256+
option :enable_login, true # See #other_phase
257+
258+
# Customization Options:
259+
option :on_login, nil # See #request_phase
260+
option :on_validation, nil # See #registration_phase
261+
option :on_registration, nil # See #registration_phase
262+
option :on_failed_registration, nil # See #registration_phase
263+
option :locate_conditions, ->(req) { { model.auth_key => req['auth_key'] } }
264+
```
265+
266+
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. 😭
267+
248268
## License
249269

250270
MIT License. See LICENSE for details.

0 commit comments

Comments
 (0)