Skip to content

Commit

Permalink
Add README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
Rein Henrichs committed Sep 27, 2011
1 parent c268698 commit b71d6c3
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2011 Rein Henrichs, http://reinh.com

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
42 changes: 42 additions & 0 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
= config_badger

Config Badger don't care.

== Summary

Config Badger makes it easy to set up a central config repository. It uses a
pluggable storage system so you can start with YAML files and easily switch to
a service (Redis, Zookeeper, etc) as your needs require.

== Usage

Examples will use the YAML storage.

Set Config Badger's options at load time (for instance, in a Rails environment.rb):

ConfigBadger.options = {
:store => ConfigBadger::YAMLStore,
:path => Rails.root + 'config'
}

YAML files in config/ can now be addressed by their name. They must contain
your config values namespaced by environment, similar to database.yml. In fact,
Config Badger can read your database.yml:

# database.yml
---
development:
adapter: mysql
user: root

Can be read like so:

ConfigBadger['database']['adapter'] => 'mysql'

== License

MIT, see {LICENSE}[rdoc-ref:LICENSE]

== Contributors

Rein Henrichs:: mailto:reinh@reinh.com

0 comments on commit b71d6c3

Please sign in to comment.