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

Add docs for upgrading from dropwizard-guice #47

Merged
merged 6 commits into from
Aug 16, 2019
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,15 @@ binding, [for example](https://github.com/jhaber/dropwizard-guicier-example/blob
There is an [example project](https://github.com/jhaber/dropwizard-guicier-example) you can clone and play with if you'd like to get
going right away.

## Upgrading from dropwizard-guice
There are a couple important changes to be aware of when upgrading from [dropwizard-guice](https://github.com/HubSpot/dropwizard-guice).

### AutoConfig has been removed
[Reasoning and potential workarounds here](https://github.com/HubSpot/dropwizard-guicier/issues/41). The workarounds are however, not recommended.

### Explicit Bindings Required
All objects that you wish to inject must be explicitly bound. Just-in-time bindings are not supported by default. This is the case despite you enabling explicit binnding in your own module.

You can however (albeit not recommended) disable the explicit binding behavior by setting `enableGuiceEnforcer(false)` on the `GuiceBundle` within your DW application.

Enjoy!