README.md in config_curator-0.1.1 vs README.md in config_curator-0.2.0
- old
+ new
@@ -1,18 +1,20 @@
# Config Curator
-by Evan Boyd Sosenko.
-
-_Simple and intelligent configuration file management._
-
[](https://rubygems.org/gems/config_curator)
[](./LICENSE.txt)
[](https://gemnasium.com/razor-x/config_curator)
[](https://travis-ci.org/razor-x/config_curator)
[](https://coveralls.io/r/razor-x/config_curator)
[](https://codeclimate.com/github/razor-x/config_curator)
+by Evan Boyd Sosenko.
+
+_Simple and intelligent configuration file management._
+
+## Description
+
## Installation
Add this line to your application's Gemfile:
````ruby
@@ -46,30 +48,64 @@
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
+## Development and Testing
+### Source Code
+
The [Config Curator source](https://github.com/razor-x/config_curator)
is hosted on GitHub.
To clone the project run
````bash
$ git clone https://github.com/razor-x/config_curator.git
````
+### Rake
+
+Run `rake -T` to see all Rake tasks.
+
+````
+rake all # Run all tasks
+rake build # Build config_curator-0.0.0.gem into the pkg directory
+rake bump:current # Show current gem version
+rake bump:major # Bump major part of gem version
+rake bump:minor # Bump minor part of gem version
+rake bump:patch # Bump patch part of gem version
+rake bump:pre # Bump pre part of gem version
+rake bump:set # Sets the version number using the VERSION environment variable
+rake install # Build and install config_curator-0.0.0.gem into system gems
+rake release # Create tag v0.0.0 and build and push config_curator-0.0.0.gem to Rubygems
+rake rubocop # Run RuboCop
+rake rubocop:auto_correct # Auto-correct RuboCop offenses
+rake spec # Run RSpec code examples
+rake yard # Generate YARD Documentation
+````
+
+### Guard
+
+Guard tasks have been separated into the following groups:
+
+- `doc`
+- `lint`
+- `unit`
+
+By default, Guard will generate documentation, lint, and run unit tests.
+
## 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`).
-5. Create a new Pull Request.
+3. Make changes. Write and run tests.
+4. Commit your changes (`git commit -am 'Add some feature'`).
+5. Push to the branch (`git push origin my-new-feature`).
+6. Create a new Pull Request.
## License
Config Curator is licensed under the MIT license.