README.md in commitment-0.0.1.pre vs README.md in commitment-0.1.0
- old
+ new
@@ -1,39 +1,45 @@
# Commitment
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/commitment`. To experiment with that code, run `bin/console` for an interactive prompt.
+Commitment is [Rails::Railtie](http://api.rubyonrails.org/classes/Rails/Railtie.html) gem.
+Commitment provides a series of [Rake](https://github.com/ruby/rake) tasks for [Rails](http://rubyonrails.org) applications.
-TODO: Delete this and the text above, and describe your gem
+The goal of Commitment is to consolidate common tasks that we use to uphold our
+software development commitment:
+* Code coverage
+* Programatic style enforcement
+* Vulnerability scans
+* Linting
+
+As we work on our code, we want to make sure we are keeping our commitment.
+If we fail to do so, the build is broken.
+
## Installation
-Add this line to your application's Gemfile:
+Before you get started, make sure all of your project changes are committed.
+Commitment doesn't change too many things, but its nice to "install" something into a clean work area.
+Now, add this line to your application's Gemfile:
+
```ruby
-gem 'commitment'
+group :development, :test do
+ gem 'commitment'
+end
```
-And then execute:
+And then go to your console and `cd` into the project. You'll run the following two commands:
- $ bundle
+```console
+$ bundle
+$ rails generate commitment:install
+```
-Or install it yourself as:
+Several files will be added to your project. These are configuration files for the underlying tasks that will be run.
+Other files will be updated so that Commitment can do its job.
- $ gem install commitment
+The `$ rails generate commitment:install` will report as output all files that were changed or updated.
+If you started with a clean work area, you can use your version control tools to see what changes were made.
-## Usage
+## Roadmap
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/commitment/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
+The Commitment gem presently does not make its own commitments. I'd like to fix that.