-
Notifications
You must be signed in to change notification settings - Fork 17
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 bookdown docs and restructure main README.md file. #82
Add bookdown docs and restructure main README.md file. #82
Conversation
2d39ca8
to
48e5393
Compare
README.md
Outdated
define the `scope` (which is either the string `request` or `session`), define a boolean value for `lazy`, or define | ||
a boolean value for `singleton`. The following configuration creates a lazy-loaded, singleton, request-aware instance: | ||
Next up you need to create a configuration class `MyConfiguration`. The | ||
class needs to be marked with a @Configuration annotation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be good to markup @Configuration
, to make it that much easier to read.
README.md
Outdated
} | ||
``` | ||
|
||
To inject a dependency, simply call the respective method: | ||
To declare an configuration entry, simply add a method to your |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be "a configuration entity" instead of "an configuration entity". Here's the rule I base that statement on.
This commit contains several changes, covering grammar, markup, spelling, and some language usage conventions.
I made a couple of amendments. Thoughts? |
Introducing bookdown as a new dependency and moved the documentation from the main README.md file to the bookdown documentation.