Readme on main branch has outdated instructions

varvet / pundit

Minimal authorization through OO design and pure Ruby classes

MIT License

8.28k stars 629 forks source link

Readme on main branch has outdated instructions #718

Closed scarhand closed 2 years ago

scarhand commented 2 years ago

The Installation section in the readme on the main branch instructs you to

Include Pundit::Authorization in your application controller

However, all the v2 branches (correctly) instruct you to include Pundit. As someone who just blindly copy-pastes instructions from readme's, it took me some time to figure out what caused the uninitialized constant Pundit::Authorization :)

Burgestrand commented 2 years ago

Hi! Yes, the README is newer than the most recently released version.

The first link at the very top of the README links explicitly to the API documentation, which is the currently released version. One should use the documentation for the version they are using.

Burgestrand commented 2 years ago

Hi! I just wanted to let you know I added a note about the README on main possibly being different from what's released, I hope this will help reducing future confusion!