Forrst badge using jQuery and Forrst API v1
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
images
.gitignore
README
demo.html
jquery.forrst_badge.css
jquery.forrst_badge.js

README

--------------------------------------------------
README
--------------------------------------------------

jQuery Forrst Badge is a jQuery plugin allowing you to display your latest public Forrst posts.

Homepage: http://www.maverickconceptions.com/2010/10/21/forrst-badge/

Demo: http://www.maverickconceptions.com/demos/forrst_badge/index.html 

This documentation is highly in flux as I am in the middle of alpha testing this right now. I will be flushing out all the explanations of all the options once I finish making them work ;) 



*******************************************
CONFIGURATION
*******************************************

+ jQuery 1.4.2+ (Developed on 1.4.2 and tested on 1.4.3. I haven't tested it with older versions. If you do and it works, drop me a line at lwallenstein@gmail.com)




*******************************************
INSTALLATION
*******************************************

You can see a full installation in the demo.html file included in this repo, however here are the itemized steps.

STEP 1: Include the plugin script after jQuery
-------
<!-- Script for Forrst Badge Widget -->
<script src="jquery.forrst_badge.js"></script>


STEP 2: Include the CSS in the head of the document
-------
<!-- CSS for Forrst Badge Widget: implied media="all" -->
<link rel="stylesheet" href="jquery.forrst_badge.css?v=1" />


STEP 3: In the body of your documents, create a container where you want the badge to display
-------
<div id="sample_badge"></div>


STEP 4: Call the script (with minimal default options.. see configuration section for more)
-------
<script>
    $("#sampl_badge").ForrstBadge({
        login: "forrst"
    });
</script>
    
    

*******************************************
CONFIGURATION
*******************************************

Minmal Configuration for badge:

<script>
    $("#sample_badge").ForrstBadge({
        login: "FORRST_LOGIN"
    });
</script>

Options for Badge

<script>
    $("#sample_user_badge").ForrstBadge({
        login: "FORRST_LOGIN"
        sorting: "ascending", // ascending or descending for repos (user badge) and issues (project badge)
        theme: "forrst", // adds value as class for entire badge
        include_forrst_logo: true, // show a lil love
        image_path: "images/",  // path to your images directory
        animate_style: "slide", //slideDown or show
        repo_count: "10" // maximum number of repos to be displayed
    });
</script>