flowdock
========

Ruby Gem for using the Flowdock API.

* http://www.flowdock.com/api

Compatibility
-------------

flowdock gem has been tested under Ruby 1.8.7.

Requirements
------------

* HTTParty

Install
-------

* gem install flowdock

Example
-------

  require 'flowdock'

  # create a new Flow object with target flow's api token and sender information
  flow = Flowdock::Flow.new(:api_token => "56188e2003e370c6efa9711988f7bf02", 
    :source => "myapp", 
    :from => {:name => "John Doe", :address => "john.doe@yourdomain.com"})

  # send message to the flow
  flow.send_message(:subject => "Greetings from Flowdock API Gem!", 
    :content => "<h2>It works!</h2><p>Now you can start developing your awesome application for Flowdock.</p>", 
    :tags => ["cool", "stuff"])
	 
API methods
-----------

* Flow methods

  send_message(params) - Send message to flow. Required parameters for message are :subject and :content. Optional parameter :tags can be used to add tags to message. Currently messages are always sent in the HTML format.


Copyright
---------

Copyright (c) 2011 Flowdock Ltd. See MIT-LICENSE for further details.