scribblelivefeed v2.5.8

Scribble Live Feed Widget

The Scribble Live Feed Widget, create a news feed with the most recent posts in your ScribbleLive Stream. This project is a fork of the recent-posts widget by Matt Mccausland.

Getting started

Add the main scribblelivefeed.js to the head of your page, and the tag below wherever you like below that.

<script type="text/javascript">

    var ScribbleLiveInstance = new scribblelivefeed({
        APIToken: "",
        EventId: "",
        TotalPostsToShow: 10,
        WhereToAddPosts: ""

    });

</script>

var ScribbleLiveInstance = new ScribbleLiveFeed

The variable name can be anything you like. It allows you to add more than one of these widgets to the same page. Give each instance a different variable name and you're good to go.

APIToken

To get an API token you must have a ScribbleLive account. Log in to https://client.scribblelive.com, go to the API section, and either grab a token if you already have one or generate a new one.

EventId

The id of the ScribbleLive event you would like to display. You can find this by logging in to https://client.scribblelive.com, and going to the API section of your event. The id it at the top of the API section.

TotalPostsToShow

The number of posts you'd like to show in integer form. If left blank it will default to 10. On load it will load the newest x posts. It will keep the list at x posts by deleting the older posts as new posts are added.

WhereToAddPosts

This is the id of the DOM element on your page that you would like to add the list of posts to. No hash tag required, just "DOMElementID". That's It!

__There is a lot of other options for you to customize your widget!

Add the scripts to your page, set the options correctly, and you're good to go.

Updating the package

When you make changes, you can update the package using

npm version <update_type>

where update_type is one of the semantic versioning release types, patch, minor, or major. This command will change the version number in package.json. Note that this will also add a tag with this release number to your git repository if you have one.

After updating the version number, you can run

npm publish

After updating this package, go to your main project (the one that youse this lib as a dependency) and update the scribblelivefeed version in package.json