From 4766f36a4d74924f21ff329c4318ce4e069ffa04 Mon Sep 17 00:00:00 2001
From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Wed, 3 Mar 2010 17:53:05 +0000
Subject: Pulled in the interface changes.

git-svn-id: http://code.elgg.org/elgg/trunk@5257 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 mod/twitterservice/vendors/twitter/readme.txt | 55 +++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 mod/twitterservice/vendors/twitter/readme.txt

(limited to 'mod/twitterservice/vendors/twitter/readme.txt')

diff --git a/mod/twitterservice/vendors/twitter/readme.txt b/mod/twitterservice/vendors/twitter/readme.txt
new file mode 100644
index 000000000..a01b768af
--- /dev/null
+++ b/mod/twitterservice/vendors/twitter/readme.txt
@@ -0,0 +1,55 @@
+Twitter for PHP (c) David Grudl, 2008 (http://davidgrudl.com)
+
+
+Introduction
+------------
+
+Twitter for PHP is a very small and easy-to-use library for sending 
+messages to Twitter and receiving status updates.
+
+
+Project at GoogleCode: http://twitter-php.googlecode.com
+Twitter's API documentation: http://groups.google.com/group/twitter-development-talk/web/api-documentation
+My PHP blog: http://phpfashion.com
+
+
+Requirements
+------------
+- PHP (version 5 or better)
+- cURL extension
+
+
+Usage
+-----
+
+Create object using your credentials (user name and password)
+
+	$twitter = new Twitter($userName, $password);
+
+The send() method updates your status. The message must be encoded in UTF-8:
+
+	$twitter->send('I am fine today.');
+
+The load() method returns the 20 most recent status updates 
+posted in the last 24 hours by you and optionally by your friends:
+
+	$withFriends = FALSE;
+	$channel = $twitter->load($withFriends);
+
+The returned channel is a SimpleXMLElement object. Extracting 
+the information from the channel is easy:
+
+	foreach ($channel->status as $status) {
+		echo "message: ", $status->text;
+		echo "posted at " , $status->created_at;
+		echo "posted by " , $status->user->name;
+	}
+
+
+Files
+-----
+readme.txt        - This file.
+license.txt       - The license for this software (New BSD License).
+twitter.class.php - The core Twitter class source.
+send.php          - Example sending message to Twitter.
+load.php          - Example loading statuses from Twitter.
-- 
cgit v1.2.3