kato-cli 0.0.2 → 0.0.3

data/README.md

@@ -16,15 +16,52 @@ Or install it yourself as:
 
     $ gem install kato-cli
 
+## Configuration
+
+At minimum, `kato` needs to be given a list of available rooms. This is
+specified in `~/.kato.yml`. Provide nicknames for rooms to access them more
+easily when posting. For example,
+
+	room-list:
+	  dev: de8cba109388dee98498
+	  meetings: 3d809831aa8481177dcce
+
+defines a room called `dev` with the room id `de8cba109388dee98498` and another
+room called `meetings` with room id `3d809831aa8481177dcce`.
+
+This allows you to specify the room by its nickname when invoking the `kato`
+command:
+
+	$ kato --room dev
+
+You can also configure a default room to send messages to as well as a default
+display name.
+
+	room: dev
+	user: tommcdo
+
 ## Usage
 
     kato [-u|--user USERNAME] [-f|--renderer text|markdown|code] [-r|--room ROOM]
 
-Message is read from `stdin`.
+* `-u` or `--user` specifies the display name to send the message from
+* `-f` or `--renderer` specifies how the message will be rendered (`text`, `markdown`
+   or `code`)
+* `-r` or `--room` specifies the room (by its nickname as set in `~/.kato.yml`) to
+   send the message to
+
+The message will be read from standard input. You can either pipe another program's
+output into `kato` or type it into the command line, followed by the end-of-file
+signal (usually `Ctrl-D`).
+
+## Vim integration
+
+Check out [kato.vim](https://github.com/tommcdo/vim-kato) if you'd like to send
+code snippets directly from inside Vim.
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/kato-cli/fork )
+1. Fork it ( http://github.com/tommcdo/kato-cli/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`)

data/bin/kato

@@ -5,9 +5,7 @@ require 'optparse'
 require 'yaml'
 
 user = 'kato-cli'
-options = {
-  :renderer => :text,
-}
+options = {}
 
 config_file = File.expand_path('~/.kato.yml')
 unless File.readable?(config_file)
@@ -26,7 +24,7 @@ OptionParser.new do |opts|
   opts.banner = "Usage: kato [options]"
   opts.on('-u', '--user NAME', 'Username') { |v| user = v }
   opts.on('-r', '--room NAME', 'Room') { |v| room = config['room-list'][v] }
-  opts.on('-f', '--renderer [TYPE]', [:text, :markdown, :code], 'Renderer (text, markdown, code)') { |v| options[:renderer] = v }
+  opts.on('-f', '--renderer [TYPE]', [:default, :markdown, :code], 'Renderer (default, markdown, code)') { |v| options[:renderer] = v }
 end.parse!
 
 Kato::Cli.post(user, STDIN.read, room, options)

data/lib/kato/cli/version.rb

@@ -1,5 +1,5 @@
 module Kato
   module Cli
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kato-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-15 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler