Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md for v3.0.0 #145

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

marijnvanwezel
Copy link

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 1003ca1 and 1d16719 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

@marijnvanwezel marijnvanwezel requested a review from a team as a code owner November 13, 2023 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant