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 bookdown docs and restructure main README.md file. #82

Merged
merged 3 commits into from
Mar 13, 2017

Conversation

shochdoerfer
Copy link
Member

Introducing bookdown as a new dependency and moved the documentation from the main README.md file to the bookdown documentation.

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.
Copy link
Contributor

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
Copy link
Contributor

@settermjd settermjd Mar 1, 2017

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.
@settermjd
Copy link
Contributor

I made a couple of amendments. Thoughts?

@shochdoerfer shochdoerfer merged commit 62c9448 into bitExpert:master Mar 13, 2017
@shochdoerfer shochdoerfer deleted the feature/bookdown_docs branch March 13, 2017 09:52
@shochdoerfer shochdoerfer added this to the 0.9.0 milestone Mar 15, 2017
@shochdoerfer shochdoerfer mentioned this pull request Mar 19, 2017
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.

None yet

2 participants