README.md in akamairb-0.0.1 vs README.md in akamairb-0.0.2
- old
+ new
@@ -1,29 +1,43 @@
# Akamairb
-TODO: Write a gem description
+Simple command-line tool for managing Akamai cache purges.
## Installation
-Add this line to your application's Gemfile:
+Install it yourself as:
- gem 'akamairb'
+ $ gem install akamairb
-And then execute:
+## Usage
- $ bundle
+### Setup:
-Or install it yourself as:
+ Akamairb needs a special file `.akamai.yml` in your home directory.
- $ gem install akamairb
+ The format of the `.akamai.yml` file is pretty straighforward
-## Usage
+ user: YOUR_USER
+ pass: YOUR_PASSWORD
-TODO: Write usage instructions here
+### Commands:
+
+ * akamai help [COMMAND] # Describe available commands or one specific command
+ * akamai purge URLS # purge urls from Akamai
+ * akamai show ID # show progress of a purge
+### Params:
+
+ * --debug # Show raw response from akamai
+
## Contributing
1. Fork it ( http://github.com/<my-github-username>/akamairb/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 new Pull Request
+
+
+## THANKS
+
+This tool is shamelessly inspired in Juan Lupion's [tacoma](https://github.com/pantulis/tacoma)