public
Description: Tinder is an Ruby API for interfacing with Campfire, the 37Signals chat application.
Homepage: http://tinder.rubyforge.org/
Clone URL: git://github.com/collectiveidea/tinder.git
Click here to lend your support to: tinder and make a donation at www.pledgie.com !
tobias (author)
Thu Oct 08 06:36:04 -0700 2009
brandon (committer)
Thu Oct 08 06:53:21 -0700 2009
tinder /
name age message
file .gitignore Fri Sep 11 22:45:25 -0700 2009 Convert to Jewel and clean some things up [brandon]
file CHANGELOG.txt Thu Aug 27 04:54:32 -0700 2009 Update changelog and bump version [brandon]
file Manifest.txt Wed Jan 28 18:47:39 -0800 2009 Preparing for release 1.2.0 release and fix ver... [brandon]
file README.txt Thu Oct 08 06:53:21 -0700 2009 Fixed typo in README. [tobias]
file Rakefile Fri Sep 11 22:45:25 -0700 2009 Convert to Jewel and clean some things up [brandon]
file VERSION Fri Sep 11 22:45:25 -0700 2009 Convert to Jewel and clean some things up [brandon]
file init.rb Tue Jan 23 16:20:48 -0800 2007 moved stuff around added contributions from Ter... [brandon]
directory lib/ Fri Sep 11 22:45:25 -0700 2009 Convert to Jewel and clean some things up [brandon]
directory site/ Tue Jul 07 06:10:43 -0700 2009 Add parsing of the periodic timestamps to the t... [Marcel Cary]
directory spec/ Fri Sep 11 22:54:15 -0700 2009 Update README [brandon]
directory test/ Fri Sep 11 22:45:25 -0700 2009 Convert to Jewel and clean some things up [brandon]
file tinder.gemspec Fri Sep 11 22:45:25 -0700 2009 Convert to Jewel and clean some things up [brandon]
README.txt
= Tinder - get the Campfire started

Tinder is a library for interfacing with Campfire, the chat application from 37Signals. Unlike Marshmallow, it is 
designed to be a full-featured API (since 37Signals doesn't provide a real one), allowing you to programatically manage 
and speak/listen in chat rooms.

== Usage

  campfire = Tinder::Campfire.new 'mysubdomain'
  campfire.login 'myemail@example.com', 'mypassword'

  room = campfire.create_room 'New Room', 'My new campfire room to test tinder'
  room.rename 'New Room Name'
  room.speak 'Hello world!'
  room.paste "my pasted\ncode"
  room.destroy

  room = campfire.find_room_by_guest_hash 'abc123', 'John Doe'
  room.speak 'Hello world!'
  
  See the RDoc for more details.

== Installation

Tinder can be installed as a gem or a Rails plugin:

  gem install tinder
  
  script/plugin install git://github.com/collectiveidea/tinder.git
  
== How to contribute

If you find what looks like a bug:

1. Check the GitHub issue tracker to see if anyone else has had the same issue.
   http://github.com/collectiveidea/tinder/issues/
2. If you don't see anything, create an issue with information on how to reproduce it.

If you want to contribute an enhancement or a fix:

1. Fork the project on github.
   http://github.com/collectiveidea/tinder
2. Make your changes with tests.
3. Commit the changes without making changes to the Rakefile, VERSION, or any other files that aren't related to your 
enhancement or fix
4. Send a pull request.

== ToDo

* Tests! (unit and remote)
* Marshmallow-style integration scripts for exception notification and continuous integration