Skip to content
Browse files

Documentation update for XMPP

  • Loading branch information...
1 parent 754c8c6 commit 263b99488bc165c56e3c45b061191b164775af8a @kennethkalmer kennethkalmer committed Jan 24, 2010
Showing with 16 additions and 10 deletions.
  1. +6 −0 History.txt
  2. +8 −8 README.rdoc
  3. +1 −2 TODO.txt
  4. +1 −0 lib/daemon_kit/jabber.rb
View
6 History.txt
@@ -1,3 +1,9 @@
+== 0.1.18 (WIP)
+
+* Evented XMPP now handled by blather
+* Boot script fixes
+* Removed Jabber generator, deprecating Jabber class (use XMPP)
+
== 0.1.7.12 2009-12-04
* Bug fix, don't load environment files twice [grockit]
View
16 README.rdoc
@@ -13,7 +13,7 @@ Using simple built-in generators it is easy to created evented and non-evented d
Supported generators:
-* XMPP bot (non-evented)
+* XMPP bot (evented)
* AMQP consumer (evented)
* Nanite agent
* Cron-style daemon
@@ -34,19 +34,19 @@ Get some help
The above command generates a skeleton daemon environment for you to adapt.
- $ daemon-kit [/path/to/your/daemon] -i jabber
+ $ daemon-kit [/path/to/your/daemon] -i xmpp
-Use the 'jabber' generator instead of the default one.
+Use the 'xmpp' generator instead of the default one.
== Generators
-Currently six generators exist: default, jabber, amqp, cron, nanite & ruote
+Currently six generators exist: default, xmpp, amqp, cron, nanite & ruote
The default generator creates a simple daemon with an infinite loop inside that you can adapt.
-=== Jabber Generator
+=== XMPP Generator
-The jabber generator creates a simple daemon that leverages the xmpp4r-simple[http://xmpp4r-simple.rubyforge.org/] gem to process inbound messages. The daemon will manage the roster and other little tasks, leaving you to provide the hooks for processing messages, presence notifications and subscription request.
+The jabber generator creates a simple daemon that leverages the blather[http://blather.squishtech.com/] gem to process inbound messages. The daemon will manage the roster and other little tasks, leaving you to provide the hooks for processing messages, presence notifications and subscription request.
=== Cron Generator
@@ -81,7 +81,7 @@ Rubigen is not required for the regular running of a daemon and is thus a develo
Depending on the generator you choose for your daemon, it might require additional gems to run.
-* jabber - xmpp4r-simple[http://xmpp4r-simple.rubyforge.org]
+* xmpp - blather[http://blather.squishtech.com/]
* cron - rufus-scheduler[http://github.com/jmettraux/rufus-scheduler] (at least version 2.0.0)
* amqp - amqp[http://github.com/tmm1/amqp]
* nanite - nanite[http://github.com/ezmobius/nanite]
@@ -92,7 +92,7 @@ Depending on the generator you choose for your daemon, it might require addition
Currently recommended to stick to the git repo:
$ git clone git://github.com/kennethkalmer/daemon-kit.git
- $ rake gem
+ $ rake build
$ gem install pkg/daemon-kit-X.X.X.gem
Stable versions, when released are available directly from Gemcutter:
View
3 TODO.txt
@@ -11,10 +11,9 @@ This is purely a drop in the bucket of what has to come...
* Support for custom error handlers in the project
* Easy configuration of an ORM of choice, including patching it if needed (ActiveRecord *cough*)
* Improved generators for creating skeleton daemons:
- * Evented jabber bot
* Empty periodic event loop
* Empty periodic loop (non-evented)
- * Queue (SQS, AMQP, etc) pollers
+ * Queue (SQS, etc) pollers
* Rake tasks for generating:
* Sys-V style init scripts
* Plenty of docs, seriously a lot of docs
View
1 lib/daemon_kit/jabber.rb
@@ -28,6 +28,7 @@ def instance
private :new
def run
+ DaemonKit.logger.warn "Please use the new XMPP daemons, this class is deprecated"
DaemonKit.logger.info "Starting jabber loop"
loop do

0 comments on commit 263b994

Please sign in to comment.
Something went wrong with that request. Please try again.