safubot 0.0.3 → 0.0.4

data/.yardoc/checksums

@@ -1,9 +1,9 @@
 lib/safubot.rb da2c6f1fa7e7a17064469e0a5409f5dc2a6ec7ab
-lib/safubot/bot.rb 91a9512ec77a70a4a3bf3d1235d81f546cae7765
+lib/safubot/bot.rb fe107278c4696a5ec095063612638b484b104deb
 lib/safubot/log.rb c341c5e6a54a908ee8431b5aac2aa7c3472eaeed
-lib/safubot/xmpp.rb 253c1ef4b93f85f4cfd55d8fb561984eb1bcf151
+lib/safubot/xmpp.rb d09fd09c28f48282d5f09228659d58b20f69c734
 lib/safubot/evented.rb 8e90ab5b812eb12113095a8bdde7a96ba0e62d1f
-lib/safubot/version.rb 67c555f319499e0bcc596a73152df9f0797da190
-lib/safubot/twitter.rb 414b3cabef1611923f18d779d279ce0b6f3128b8
+lib/safubot/version.rb f313c43342f6e25736022460f1db64f16e2562f6
+lib/safubot/twitter.rb 883a32a176acdf1233e29f122d10a0cce0719664
 lib/safubot/known_user.rb 8e2ce383a220c28d8729540be7fc0dfeca3f48fc
-lib/safubot/test_helper.rb 892633f1707378964059f7209da7771669fdb993
+lib/safubot/test_helper.rb a4ea2e3641880c51d3cdd689e47b09cffe6d0bc6

data/README.md

@@ -10,7 +10,7 @@ Safubot is a chatbot framework for Twitter and XMPP which aims to abstract away
 Safubot uses [MongoDB](http://www.mongodb.org) for storage. It's [easy to install](http://www.mongodb.org/display/DOCS/Quickstart+Unix) and pretty awesome!
 
 ## <a name="documentation">Documentation</a>
-[http://rdoc.info/gems/safubot](http://rdoc.info/gems/safubot)
+[http://rdoc.info/gems/safubot/frames](http://rdoc.info/gems/safubot/frames)
 
 ## <a name="example">Sample Usage</a>
 	require 'safubot'
@@ -21,10 +21,7 @@ Safubot uses [MongoDB](http://www.mongodb.org) for storage. It's [easy to instal
 		# to do something more sophisticated than an authless localhost connection.
 		super(:database => "niftybot")
 
-		# To access the underlying delegation targets:
-		# Safubot::Twitter::Bot bot.twitter
-		# ::Twitter::Client bot.twitter.client
-		# ::TweetStream::Client bot.twitter.stream
+		# This creates a Safubot::Twitter::Bot instance at @twitter
 		enable_twitter({
 			:username => "niftybot",
 			:consumer_key => CONSUMER_KEY,
@@ -33,9 +30,7 @@ Safubot uses [MongoDB](http://www.mongodb.org) for storage. It's [easy to instal
 			:oauth_token_secret => OAUTH_TOKEN_SECRET
 		})
 
-		# Similarly, for XMPP:
-		# Safubot::XMPP::Bot bot.xmpp
-		# ::Blather::Client bot.xmpp.client
+		# Similarly, this makes a Safubot::XMPP::Bot instance at @xmpp
 		enable_xmpp({
 			:jid => "niftybot@jabber.org/niftyhost",
 			:password => JABBER_PASSWORD
@@ -81,7 +76,9 @@ Safubot::Log behaves as a Logger instance and will write to stdout by default. Y
 
 ### Update our twitter account
 
-	@twitter.client.update("Hello there, wonderful, scary world of Twitter! I am so *not* a spambot.")
+	@twitter.on(:ready) do
+	  @twitter.client.update("Hello there, wonderful scary world of Twitter! I am so *not* a spambot.")
+	end
 
 ### Reply to a non-request timeline tweet
 
@@ -97,3 +94,6 @@ Safubot::Log behaves as a Logger instance and will write to stdout by default. Y
 	  @xmpp.tell('^_^@jabber.org', "You'd best be maintaining safubot!")
 	end
 
+## <a name="caveats">Caveats</a>
+
+I've yet to determine how to make multiple libraries with their own EventMachine loops play nice together, so the TweetStream and Blather clients are currently run in their own processes. Keep in mind the effect this will have on the execution context of your event handlers. MongoDB is your friend!