Installation
============

1.  Get your Twitter OAuth authentication credentials

    - Go to https://dev.twitter.com/ and sign in with your Twitter account. This account will be the default account used by the script if no Twitter username is specified.

    - Go to the My applications page at https://dev.twitter.com/apps and create a new application. You do not have to specify a callback URL.

    - Create you access token by clicking on the button 'Create my access token'.

    - In the OAuth tools tab of your application you can see all your OAuth credentials, which you will need in the next step of the installation.


2.  Configure and upload the script

    - Edit the ajax.php file and add your OAuth credentials of the previous step to the defines at the top of the file. You can also configure the cache settings here.

    - Upload the files ajax.php, codebird.php, cache.php, twitter.js and twitter.css to your website.


3.  Add the script to your webpage

    - Add the javascript file to the head section of your webpage:

    <script type="text/javascript" src="/path/totwitter.js"></script>

    - If you want to use the default styling of this script, add the css stylesheet to the head section of your webpage:

    <link rel="stylesheet" href="/path/to/twitter.css" />

    - Make sure the paths to the Javascript and CSS files are correct.

    - Add the code to display the Twitter content to your webpage by placing the following code at the desired location in the body of your webpage:

    <div id="twitter-container"></div>
    <script>
        var twitter = new TwitterWidget({
            ajaxRequestPath: '/path/to/ajax.php',
        });
    </script>

    - Make sure the path to ajax.php is correct.

4.  Configure the Twitter Widget to display the content you want. The default content shown is your home timeline. For other options check the documentation in the README.txt file or the examples in the examples directory that came with this script.