README.md in mini_check-0.2.0 vs README.md in mini_check-0.3.0

- old
+ new

@@ -65,9 +65,40 @@ } ``` The http status code will be 200 if all checks are healthy and 500 otherwise. +## Version + +```ruby +MyVersionCheck = MiniCheck::VersionRackApp.new(name: 'Cards', path: '/admin/version', build_file: './config/build.yml').tap do |app| + app.metadata["Whatever Here"] = "Bla Bla" + ... +end +``` + +The build_file can be a YML or a plain text file. It needs to have pairs key-values. + +If you now visit `http://localhost:XXXX/admin/version.json` you should get something like: + +```json +{ + "Application Name": "Cards", + "Whatever Here": "Bla Bla" +} +``` + +If you now visit `http://localhost:XXXX/admin/version` you should get something like: + +``` + Application Name=Cards + Whatever Here=Bla Bla +``` + +## Maintaining + +Here is a good tutorial on this: +[Developing a RubyGem using Bundler](https://github.com/radar/guides/blob/master/gem-development.md). ## License Released under the MIT License. See the [LICENSE](LICENSE.md) file for further details.