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
commit  7cae9553a50f6e3bddfd7666020926566ee87409
tree    9c05436f7270acefdaa977bc9a95ffe7288774ef
parent  041c3d433580cb0578bdd091547e52077c89c3ce
tinder / README.txt
100644 49 lines (31 sloc) 1.621 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
= 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