Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 49 lines (32 sloc) 1.133 kB
f33907b @mhfs renaming to firebot
authored
1 Firebot
4254f03 @mhfs readme and license
authored
2 =========
3
f33907b @mhfs renaming to firebot
authored
4 Firebot is a bot for Campfire, the chat application from 37Signals, that offers an extensible
4254f03 @mhfs readme and license
authored
5 interface to programmatically integrate it with other applications/services.
6
e2812cd @mhfs dummy ping pong plugin. missing tests.
authored
7 WARNING
8 -------
9
f33907b @mhfs renaming to firebot
authored
10 FIREBOT IS UNDER DEVELOPMENT. NO STABLE RELEASE IS AVAILABLE.
e2812cd @mhfs dummy ping pong plugin. missing tests.
authored
11
4254f03 @mhfs readme and license
authored
12 Usage
13 -----
14
f33907b @mhfs renaming to firebot
authored
15 Firebot comes with its own executable. `firebot` in the terminal
e2812cd @mhfs dummy ping pong plugin. missing tests.
authored
16 gives you its options:
17
18 Tasks:
f33907b @mhfs renaming to firebot
authored
19 firebot create_config # Create a sample config file in ~/.firebot
20 firebot help [TASK] # Describe available tasks or one specific task
21 firebot start # Startup the Firebot daemon
22 firebot stop # Stop the Firebot daemon
e2812cd @mhfs dummy ping pong plugin. missing tests.
authored
23
24 The steps to get it up and running are:
25
f33907b @mhfs renaming to firebot
authored
26 1. Run `firebot create_config`
27 2. Tweak the config file in `~/.firebot`
28 3. Run `firebot start`
4254f03 @mhfs readme and license
authored
29
30 Supported Applications/Services
31 -------------------------------
32
e2812cd @mhfs dummy ping pong plugin. missing tests.
authored
33 PingPong: dummy plugin to check the plugins interface.
4254f03 @mhfs readme and license
authored
34
35 Meta
36 ----
37
f33907b @mhfs renaming to firebot
authored
38 * Home: <https://github.com/mhfs/firebot/>
4254f03 @mhfs readme and license
authored
39
40 Author
41 ------
42
43 Marcelo Silveira :: marcelo@mhfs.com.br :: @mhfsilveira
44
45 License
46 -------
47
f33907b @mhfs renaming to firebot
authored
48 Firebot is released under the MIT Licence. Copyright &copy; 2011 Marcelo Silveira.
Something went wrong with that request. Please try again.