Skip to content

Commit

Permalink
add a short summary of the Examples
Browse files Browse the repository at this point in the history
  • Loading branch information
havocp committed Dec 5, 2011
1 parent 1e1785c commit 63b920a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Expand Up @@ -65,6 +65,19 @@ See the examples in the `examples/` directory.
You can run these from the sbt console with the commands `project
simple-app` and then `run`.

In brief, as shown in the examples:

- libraries should use a `Config` instance provided by the app,
if any, and use `ConfigFactory.load()` if no special `Config`
is provided. Libraries should put their defaults in a
`reference.conf` on the classpath.
- apps can create a `Config` however they want
(`ConfigFactory.load()` is easiest and least-surprising), then
provide it to their libraries. A `Config` can be created with
the parser methods in `ConfigFactory` or built up from any file
format or data source you like with the methods in
`ConfigValueFactory`.

## Standard behavior

The convenience method `ConfigFactory.load()` loads the following
Expand Down

0 comments on commit 63b920a

Please sign in to comment.