Skip to content
This repository was archived by the owner on Apr 2, 2024. It is now read-only.

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Cornelius Weidmann committed Sep 29, 2015
1 parent 92d5df1 commit 46980ae
Showing 1 changed file with 36 additions and 36 deletions.
72 changes: 36 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,87 +13,87 @@ Bower: `bower install jquery.kyco.googleplusfeed2 --save-dev`

Manual: Download or clone and include the minified js file after including jquery:

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
<script src="jquery.kyco.googleplusfeed2.min.js"></script>
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
<script src="jquery.kyco.googleplusfeed2.min.js"></script>

For default styling include the CSS file and loader.gif from the src directory:

<link rel="stylesheet" href="jquery.kyco.googleplusfeed2.css">
<link rel="stylesheet" href="jquery.kyco.googleplusfeed2.css">

Create a div to hold the feed and then pull the feed into it by calling the
kycoGooglePlusFeed2 method on it with the specified Google+ ID:

<div class="mydiv"></div>
<div class="mydiv"></div>

<script>
$(document).ready(function() {
$('.mydiv').kycoGooglePlusFeed2('116899029375914044550');
});
</script>
<script>
$(document).ready(function() {
$('.mydiv').kycoGooglePlusFeed2('116899029375914044550');
});
</script>

What a customisation looks like:

<div class="mydiv2"></div>

<script>
$(document).ready(function() {
$('.mydiv2').kycoGooglePlusFeed2({
id: '116899029375914044550',
feedPosts: 2, // Feed posts to show on load
postsIncrement: 1, // Number of feed posts to show on "Show more" button click
maxPosts: 5, // Max number of posts to pull before "Show more" will go to Google+, cannot excced 20 because of Google API in use
profileImageSize: 150, // Max is 250
fadeSpeed: 0, // Fade-in animation duration
loadAttachments: false, // Load images, videos, links and other attachments into feed?
orderBy: 'popularity', // Either 'date' or 'popularity'
sort: 'asc', // Either 'asc' or 'desc'
lang: 'de' // Default language, can also be set to 'de'
<div class="mydiv2"></div>

<script>
$(document).ready(function() {
$('.mydiv2').kycoGooglePlusFeed2({
id: '116899029375914044550',
feedPosts: 2, // Feed posts to show on load
postsIncrement: 1, // Number of feed posts to show on "Show more" button click
maxPosts: 5, // Max number of posts to pull before "Show more" will go to Google+, cannot excced 20 because of Google API in use
profileImageSize: 150, // Max is 250
fadeSpeed: 0, // Fade-in animation duration
loadAttachments: false, // Load images, videos, links and other attachments into feed?
orderBy: 'popularity', // Either 'date' or 'popularity'
sort: 'asc', // Either 'asc' or 'desc'
lang: 'de' // Default language, can also be set to 'de'
});
});
});
</script>
</script>


Configuration - kycoGooglePlusFeed2({ *options* })
--------------------------------------------------

id: /* Google+ ID */,
id: /* Google+ ID */,

The Google+ ID used to generate the feed.

feedPosts: 3,
feedPosts: 3,

Feed posts to show on load.

postsIncrement: 3,
postsIncrement: 3,

Number of feed posts to show on "Show more" button click.

maxPosts: 20,
maxPosts: 20,

Max number of posts to pull before "Show more" will go to Google+, cannot exceed 20
because of Google API in use.

profileImageSize: 50,
profileImageSize: 50,

Image size of the profile image, max size is 250. Also adjust CSS if changing the default.

fadeSpeed: 250,
fadeSpeed: 250,

Fade-in animation duration

loadAttachments: true,
loadAttachments: true,

Load images, videos, links and other attachments into feed?

orderBy: 'date'
orderBy: 'date'

Order posts by 'date' or 'popularity'.

sort: 'asc',
sort: 'asc',

Sort order of the orderBy parameter. Default is 'asc' (i.e. latest or most popular posts first) can be set to 'desc'.

lang: 'en'
lang: 'en'

Default language is English, can also be set to German - 'de'.

Expand Down

0 comments on commit 46980ae

Please sign in to comment.