Release v2.0.0

* Update CHANGELOG
* Add UPGRADING to detail what needs doing when upgrading

Author: patch0

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v2.0.0]
+
 ### Added
 - Added dummy route for `/auth/rpi` to add path helper `rpi_auth_login` (#44)
 - Request and routing specs inside the "dummy" testing app (#44)
@@ -67,6 +69,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - callback, logout and failure routes to handle auth
 
 [Unreleased]: https://github.com/RaspberryPiFoundation/rpi-auth/compare/v1.4.0...HEAD
+[v2.0.0]: https://github.com/RaspberryPiFoundation/rpi-auth/releases/tag/v2.0.0
 [v1.4.0]: https://github.com/RaspberryPiFoundation/rpi-auth/releases/tag/v1.4.0
 [v1.3.0]: https://github.com/RaspberryPiFoundation/rpi-auth/releases/tag/v1.3.0
 [v1.2.1]: https://github.com/RaspberryPiFoundation/rpi-auth/releases/tag/v1.2.1

UPGRADING.md

@@ -0,0 +1,18 @@
+# Upgrading rpi-auth
+
+Here are the details of the changes needed when upgrading between major versions of this gem.
+
+## v1 to v2
+
+Definitely change the following:
+
+1. [ ] Replace references to `RpiAuth::AuthenticationHelper` with `RpiAuth::Controllers::CurrentUser`.
+2. [ ] Change `extend RpiAuth::Models::Authenticatable` to `include RpiAuth::Models::Authenticatable`.
+
+You might also need to;
+
+* [ ] Remove dummy `login` route in `/config/routes.rb`, and replace references to `login_path` with `rpi_auth_login_path`.
+* [ ] Change [the railties order](https://github.com/RaspberryPiFoundation/rpi-auth/blob/v2.0.0/README.md#globbedcatch-all-routes) if your app uses globbed/catch-all routes
+
+
+