hrk 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00ba909ad81777c6630e63c91f09422d8704fc65
-  data.tar.gz: 10c5b87fbdfb08d3685c36dd1e409446e8450d7e
+  metadata.gz: 7fdb088ad0092c7030fb064ba5064526bbe3e137
+  data.tar.gz: 6780d479838bd21044daafe61caa3383036989cf
 SHA512:
-  metadata.gz: e23ed9f3d4a4c0dbc5402506cf981a65c80bc1d1b381b15942824175ddb407e4d169a55e64abe05deb4bc4fa277933cfaf7c2e47afc9eb86312a726c88e5627e
-  data.tar.gz: cf04b040079c17aecb401c2c7151f97398540fb1d83421c62edd6395f3a0215f830ac56b75816a110be2efb974ce0857b1dc5b571eba1dca580cde4aeffa363b
+  metadata.gz: a04f74b39fa8d0de1572558b121d4efb91a2a9ef78c4675fc78df844319ee7e0b229af25fb2e816d70d1f5884eba16627bc2a9c205cc3855dc5b641f47f1c8d8
+  data.tar.gz: 14ffb786524ba1ca087b3bafc28ac85063c5db654e607b019623f8704b9be901c73fa953ace1f811d5de84e42b7b8e98930a7817859350aac0f30410644409cc

data/README.md

@@ -0,0 +1,97 @@
+# Hrk
+
+Hrk 2 swim like a dolphin in a sea of heroku commands
+
+## Getting started
+
+You can install the Hrk gem using the gem command:
+
+```
+$ gem install hrk
+```
+
+Or through bundler:
+
+```
+# in your Gemfile
+gem 'hrk', group: :development
+
+$ bundle install
+```
+
+And enjoy the hrk command awesome power:
+```
+$ hrk your-heroku-remote-name logs
+```
+
+
+## What does it do?
+
+It's a command that calls the heroku toolbelt command for you, using your local
+heroku git remote name instead of that app's name.
+
+For example, let's say I've got an heroku app that's called:
+
+> this-really-long-app-name
+
+Well, I type my heroku commands like:
+
+```
+$ heroku run rake do:stuff
+```
+
+And it's easy.
+
+Yep, but now I need a staging environment and a testing environment, so I add
+other heroku repositories that I aptly call:
+
+```
+this-really-long-app-name-that-is-used-as-a-demo
+this-really-long-app-name-draft
+```
+
+Now all my heroku commands look like:
+
+```
+$ heroku run rake do:something:else -a this-really-long-app-name
+$ heroku run rake other:thing -a this-really-long-app-name-that-is-used-as-a-demo
+$ heroku run rake yet:another:task -a this-really-long-app-name-draft
+```
+
+And, let's be frank, that sucks even when I don't have to chain these commands.
+
+**Hrk to the rescue!**
+
+Now, if you're like me, you've probably named your various heroku remotes in a
+more sensible way than just your heroku app names, for example:
+
+```
+prod    => this-really-long-app-name
+staging => this-really-long-app-name-that-is-used-as-a-demo
+test    => this-really-long-app-name-draft
+```
+
+Which means that you could call the Hrk command instead of the heroku command
+using your remotes names like:
+
+```
+$ hrk prod    run rake do:some:work
+$ hrk staging run rake arrange:stuff
+$ hrk test    run rake test:some:thingy
+```
+
+Easy!
+
+## Do I still need the heroku toolbelt?
+
+Yes. The hrk command calls the heroku command for you, it does not replace it.
+
+## Very important warning!
+
+Hrk is pronounced like "a shark" because it's funny.
+
+## Boring licensing stuff
+
+Hrk is released under the GPL V3 license, and the people rejoiced.
+
+Read more at http://gplv3.fsf.org/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hrk
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Michel Belleville
@@ -17,6 +17,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/hrk
 homepage: http://github.com/Bastes/hrk
 licenses: