File: readme.txt

### Twitter class for PHP ###
=============================


## What it does ##
------------------

# The class connects to Twitter <URL:http://twitter.com/>,
# logs in with a specified username and password, and sends
# new statuses.


## How it works ##
------------------

# This class does -not- use CURL or HTTP. It uses plain
# sockets. It does so for flexibility -- more servers
# have sockets enabled than CURL or HTTP.


## What it needs ##
-------------------

# This class needs PHP -- tested on 4.4.6 and 5.2.2
# -- with socket functions enabled.


## How to use it ##
-------------------

# Check out example.php included in this package.


## Files in this package ##
---------------------------

# This package should contain the following files:
# -> Twitter.class.php ~ the main twitter class file.
# -> example.php ~ a file that demonstrates how to
                   use the twitter class.
# -> readme.txt ~ this file.