README.md in configurations-1.0.0 vs README.md in configurations-1.0.1
- old
+ new
@@ -1,7 +1,9 @@
# Configurations
+[](https://travis-ci.org/beatrichartz/configurations) [](https://codeclimate.com/github/beatrichartz/configurations) [](https://codeclimate.com/github/beatrichartz/configurations) [](http://inch-ci.org/github/beatrichartz/configurations) [](https://gemnasium.com/beatrichartz/configurations)
+
Configurations provides a unified approach to do configurations using the `MyGem.configure do ... end` idiom with the flexibility to do everything from arbitrary configurations to type asserted configurations for your gem or any other ruby code.
## Install
`gem install configurations`
@@ -10,10 +12,14 @@
`gem 'configurations', '~> 1.0.0'`
Configurations uses [Semver 2.0](http://semver.org/)
+## Compatibility
+
+Compatible with MRI 1.9.2 - 2.1, Rubinius, jRuby
+
## Why?
There are various ways to do configurations, yet there seems to be a broad consensus on the `MyGem.configure do ... end` idiom.
So instead of rolling your own, you can add this gem to your gem and get that functionality for free, plus some goodies you may want
but do not have the time to write like type assertion or nested configurations.
@@ -131,10 +137,10 @@
```
### Some caveats
-The `to_h` from above is along with `method_missing` and `initialize` the only purposely defined method which you can not overwrite with a configuration value.
+The `to_h` from above is along with `method_missing`, `object_id` and `initialize` the only purposely defined method which you can not overwrite with a configuration value.
Apart from these methods, you should be able to set pretty much any property name you like. `Configuration` inherits from `BasicObject`, so even standard Ruby method names are available.
## Contributing
YES!