janko / rodauth-rails

Rails integration for Rodauth authentication framework
https://github.com/jeremyevans/rodauth
MIT License
584 stars 40 forks source link

Minor point of confusion in README #25

Closed rmacklin closed 3 years ago

rmacklin commented 3 years ago

👋 Hi there! This gem looks really nice (and https://github.com/janko/sequel-activerecord_connection looks like a nice way to add Sequel into existing ActiveRecord-based Rails apps)!

I was reading through the documentation in the README and I found something a bit confusing at first.

The "Multiple configurations" docs introduce an example of adding a separate :admin configuration: https://github.com/janko/rodauth-rails/blob/b85d8b38110c64432c02b0acaffeeddddcee9efe/README.md#L513-L547

However, later in the docs, the name :secondary is used for the "multiple configurations" examples: https://github.com/janko/rodauth-rails/blob/b85d8b38110c64432c02b0acaffeeddddcee9efe/README.md#L582 https://github.com/janko/rodauth-rails/blob/b85d8b38110c64432c02b0acaffeeddddcee9efe/README.md#L614 https://github.com/janko/rodauth-rails/blob/b85d8b38110c64432c02b0acaffeeddddcee9efe/README.md#L624 https://github.com/janko/rodauth-rails/blob/b85d8b38110c64432c02b0acaffeeddddcee9efe/README.md#L630 https://github.com/janko/rodauth-rails/blob/b85d8b38110c64432c02b0acaffeeddddcee9efe/README.md#L652

Ultimately, I understood this, since "secondary" is used once in the initial section: https://github.com/janko/rodauth-rails/blob/b85d8b38110c64432c02b0acaffeeddddcee9efe/README.md#L543 but I think it would've been easier for me to follow if the later examples reused the :admin name. I've opened #26 to make that change, but let me know if you'd prefer something else.