https://github.com/seaofclouds/tweet

put twitter on your website with tweet, an unobtrusive javascript plugin for jquery
https://github.com/seaofclouds/tweet

Last synced: 3 days ago
JSON representation

put twitter on your website with tweet, an unobtrusive javascript plugin for jquery

• Host: GitHub
• URL: https://github.com/seaofclouds/tweet
• Owner: seaofclouds
• License: mit
• Archived: true
• Created: 2008-06-11T22:39:03.000Z (over 16 years ago)
• Default Branch: master
• Last Pushed: 2013-06-24T11:40:32.000Z (over 11 years ago)
• Last Synced: 2024-11-03T07:07:13.549Z (11 days ago)
• Language: JavaScript
• Homepage: http://tweet.seaofclouds.com
• Size: 544 KB
• Stars: 827
• Watchers: 42
• Forks: 217
• Open Issues: 7
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Tweet!

#### Put twitter on your website with tweet!, an unobtrusive javascript plugin for jquery.

## Important note about Twitter's API changes in 2013

Twitter has discontinued

its unauthenticated v1.0 API, so this widget has stopped working as of 2013-06-11.

Twitter wants your only option for on-page widgets to be their

own Embedded Timelines, but there are workarounds which involve

installing server-side code to support this widget. Please see

this

discussion for more details.

## Demos & examples

See [tweet.seaofclouds.com](http://tweet.seaofclouds.com/), or the bundled `index.html` file.

## Source

[Download tarball](http://github.com/seaofclouds/tweet/tarball/master)

## Features

  * small size and fast download time

  * will not slow down or pause your page while tweets are loading

  * display up to 100 tweets, as permitted by the twitter search api

  * display tweets from a twitter search, or from your own feed

  * optional verb tense matching, for human readable tweets

  * optionally display your avatar

  * optionally display tweets from multiple accounts!

  * automatic linking of @replies to users’ twitter page

  * automatic linking of URLs

  * automatic linking of #hashtags, to a twitter search of all your tags

  * converts <3 to a css styleable ♥ (we ♥ hearts)

  * customize the style with your own stylesheet or with other jquery plugins

  * customize the layout with a user-defined template function

  * supports RequireJS and other AMD-compatible javascript loaders

  * available on [cdnjs](http://cdnjs.com)

## Usage

1. Get [JQuery](http://jquery.com/). In these examples, we use [Google's AJAX Libraries API](http://code.google.com/apis/ajaxlibs/).

2. include jQuery and jquery.tweet.js files in your template's ``.

        

        

3. Also in ``, Initialize tweet! on page load with your Username and other options

        

            jQuery(function($){

                $(".tweet").tweet({

                    join_text: "auto",

                    avatar_size: 32,

                    count: 3,

                    loading_text: "loading tweets..."

                });

            });

        

4. In ``, include a placeholder for your tweets. They'll get loaded in via JSON. How fancy!

        


5. Style with our stylesheet in ``, or modify as you like!

        

### Contribute

Bring your code slinging skills to Github and help us develop new features for tweet!

[Github project page](http://github.com/seaofclouds/tweet/)

    git clone git://github.com/seaofclouds/tweet.git

Report bugs at http://github.com/seaofclouds/tweet/issues

### Licensed under the MIT

[License text](http://www.opensource.org/licenses/mit-license.php)



[![](http://api.coderwall.com/purcell/endorsecount.png)](http://coderwall.com/purcell)