diff options
author | danielsdeleo <dan@opscode.com> | 2013-06-01 11:41:44 -0700 |
---|---|---|
committer | danielsdeleo <dan@opscode.com> | 2013-06-01 11:42:18 -0700 |
commit | bf68670f01f2e91f1967dea241c3f9018a22aefd (patch) | |
tree | 1643523802881ad38c85401c14a1a40937464cf4 | |
parent | 09b0e99771137b5e98587a5eee18b143de06eb6a (diff) | |
download | mixlib-config-bf68670f01f2e91f1967dea241c3f9018a22aefd.tar.gz |
switch readme to markdownmodernize
-rw-r--r-- | README.md (renamed from README.rdoc) | 20 |
1 files changed, 10 insertions, 10 deletions
@@ -1,10 +1,10 @@ -== Mixlib::Config +## Mixlib::Config -Mixlib::Config provides a class-based configuration object, like the one used in Chef. To use in your project: +Mixlib::Config provides a class-based configuration object, as used in Chef. To use in your project: require 'rubygems' require 'mixlib/config' - + class MyConfig extend(Mixlib::Config) configure do |c| @@ -12,30 +12,30 @@ Mixlib::Config provides a class-based configuration object, like the one used in c[:other_value] = 'something_else' end end - + Or... class MyConfig extend(Mixlib::Config) - + first_value 'something' other_value 'something_else' end - + To check a configuration variable: MyConfig.first_value # returns 'something' MyConfig[:first_value] # returns 'something' - + To change a configuration variable at runtime: MyConfig.first_value('foobar') # sets first_value to 'foobar' - MyConfig[:first_value] = 'foobar' # sets first_value to 'foobar' - + MyConfig[:first_value] = 'foobar' # sets first_value to 'foobar' + You should populate your class with the default values for every configuration variable that might be accessed. If you try and access a variable that does not exist, Mixlib::Config will throw an <ArgumentError>. To load a ruby configuration file (which will evaluate in the context of your configuration class): MyConfig.from_file('your_config_file.rb') - + Enjoy! |