search

ueberauth / guardian_db

Guardian DB integration for tracking tokens and ensuring logout cannot be replayed.
MIT License
367 stars 87 forks source link

Update README.md for v3.0.0 #145

Open marijnvanwezel opened 10 months ago

marijnvanwezel commented 10 months ago

This pull request updates the documentation to reflect the breaking changes in v3.

It would be good to release master as a tag (say 3.0.1), or cherry-pick this commit along with 1003ca148525d8589a7b154fcb9f2a257d27eec2 and 1d1671934ae4c38c02310c324044d3542ec599ad and release that instead, as soon as possible. Namely, the current documentation on hexdocs is incorrect. Following it gives the somewhat vague error:

* (Mix) Could not start application myapp: MyApp.Application.start(:normal, []) returned an error: shutdown: failed to start child: MyApp.Telemetry
    ** (EXIT) an exception was raised:
        ** (ArgumentError) The module Guardian.DB.Token.SweeperServer was given as a child to a supervisor but it does not exist