README.md in command-cacheable-0.2.0 vs README.md in command-cacheable-0.2.1
- old
+ new
@@ -1,11 +1,10 @@
# Command::Cacheable
-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/command/cacheable`. To experiment with that code, run `bin/console` for an interactive prompt.
+Command::Cacheable wraps the command line, optionally caching standard output for later, faster
+retrieval.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,20 +19,30 @@
$ gem install command-cacheable
## Usage
-TODO: Write usage instructions here
+From the [Svnx](https://github.com/jpace/svnx) project:
-## Development
+``` ruby
+ require 'command/cacheable/command'
+ ls = Command::Cacheable::Command.new [ "ls", "/tmp" ]
+ ls.execute
+
+ lsc = Command::Cacheable::Command.new [ "ls", "/tmp" ], caching: true, cachedir: "/tmp/lscache"
+ lsc.execute
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+ diff = lsc.output - ls.output
+```
-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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`Command::Cacheable` is specifically for caching commands, and does not have the flexibility that
+the [Command](https://github.com/collectiveidea/command) gem does. For one, it does not cache
+standard error.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jpace/command-cacheable.
## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).