Skip to content

Latest commit

 

History

History
186 lines (146 loc) · 6.17 KB

README.md

File metadata and controls

186 lines (146 loc) · 6.17 KB
Raw

jQuery Lifestream Plug-in

jQuery Lifestream Logo

Show a stream of your online activity.
Check out the example or create your own lifestream instantly.

Follow us on twitter

Requirements

Supported feeds

Currently supports the following feeds natively:

Feel free to fork the project and add your own feeds in.
Just send a pull request to christianv/jquery-lifestream when you're finished.

Usage

Add the following to the or tag of your HTML page.

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
<script src="https://github.com/christianv/jquery-lifestream/raw/master/jquery.lifestream-compiled.js"></script>
<script>
  $("#lifestream").lifestream({
    "list":[
      {
        "service": "github",
        "user": "christianv"
      },
      {
        "service": "twitter",
        "user": "denbuzze"
      }
    ]
  });
</script>

The above code will always use the latest version of the script.
If you want to use it in production, download the compressed or uncompressed file and host it yourself.

Configuration

The plug-in accepts one configuration JSON object:

$("#lifestream").lifestream({
  "limit": 30,
  "list":[
    {
      "service": "github",
      "user": "christianv"
    },
    {
      "service": "twitter",
      "user": "denbuzze"
    }
  ]
});

limit: (integer) Specify how many elements you want in your lifestream (default = 10).

list: (array) Array containing other JSON objects with information about each item.
Each item should have a service and a user.
For more information about each service, check out the source code of the example page.

Commit to the project

Add your own feed

Adding in your own feed is pretty easy.
Have a look at this commit which adds support for the last.fm feed.

jQuery Templates

You have the ability to use jQuery templates for your feed.
Checkout the template page to see an overview of the current available templates.

Usage:

{
  service: 'deviantart',
  user: 'gabbyd70',
  template: {
    deviationpost: 'heeft hetvolgende gepost: <a href="${url}">${title}</a>'
  }
}

Create data:URI for an icon

  1. Convert the favicon.ico of a site to a .png file. (e.g. http://google.com/favicon.ico)
  2. Make a data:URI for it.
  3. Put the data:URI in css/lifestream.css (alphabetical order).

How to commit?

  1. Push the finished code to your own remote repository.
  2. Send a pull request to christianv/jquery-lifestream.

Code Style Guidelines

  • Indentation: 2 spaces
  • Max column width: 78 characters
  • Trailing spaces: not allowed
  • We use the following spacing rules:
for (var i = 0, j = length; i < j; i++) {

Ideas

Stuff that isn"t implemented yet, but would be nice to have:

Mentions

Places on the web where this plug-in got mentioned:

Special Thanks

Special thanks all the committers and gabbyd70 for letting us use her DeviantART username.

Version log

  • 0.1.0 jQuery Template support
  • 0.0.17 Forrst & PicPlz support
  • 0.0.16 Iusethis support
  • 0.0.15 Dailymotion & Pinboard support
  • 0.0.14 Slideshare support
  • 0.0.13 Vimeo support
  • 0.0.12 Reddit support
  • 0.0.11 Tumblr support
  • 0.0.10 DeviantART support
  • 0.0.9 Foursquare support
  • 0.0.8 Add support for Github tags
  • 0.0.7 Dribbble support
  • 0.0.6 Update links in twitter to be able to have hashes in them
  • 0.0.5 Flickr support
  • 0.0.4 Last.fm support
  • 0.0.3 Delicious support + minor bug fix in the stackoverflow code
  • 0.0.2 Youtube support
  • 0.0.1 Initial version