README.md in config_curator-0.0.1 vs README.md in config_curator-0.0.2
- old
+ new
@@ -28,10 +28,11 @@
Or install it yourself as:
````bash
$ gem install config_curator
````
+
## Documentation
The primary documentation for Config Curator is this README and the YARD source documentation.
YARD documentation for all gem versions is hosted on the
@@ -39,10 +40,16 @@
Documentation for the latest commits is hosted on
[the RubyDoc.info project page](http://rubydoc.info/github/razor-x/config_curator/frames).
## Usage
+### Scripting
+
+Config Curator is fully scriptable for easy inclusion into other Ruby programs.
+The API is well documented for this purpose
+(see [Documentation](#documentation) above).
+
## Source Repository
The [Config Curator source](https://github.com/razor-x/config_curator)
is hosted on GitHub.
To clone the project run
@@ -50,9 +57,13 @@
````bash
$ git clone https://github.com/razor-x/config_curator.git
````
## Contributing
+
+Please submit and comment on bug reports and feature requests.
+
+To submit a patch:
1. Fork it (https://github.com/razor-x/config_curator/fork).
2. Create your feature branch (`git checkout -b my-new-feature`).
3. Commit your changes (`git commit -am 'Add some feature'`).
4. Push to the branch (`git push origin my-new-feature`).