#Web Ticker v3.0.0

##Web Ticker - what is it for?

Web Ticker is a jQuery plugin that allows you to have items scrolling indefinitely across the screen. It uses some fancy calculations to ensure smooth continuous transitions. The Web Ticker content, can be varied, including text, image lists or even custom styled items. The Web Ticker API can also be used to control the scrolling, and content programatically.

##Install & Configure

###Installation

All you should need to do is look at a few of our simple examples to get started. Continue reading for step by step instructions.

1. Make sure that jQuery is available on your page, if you do not have jQuery you can include a Google hosted version by copying the code below:

    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
   

2. Download the standalone jquery.webticker.min.js or install via npm

    npm install webticker
   

   and include it like this:

    <script src="./path/to/jquery.webticker.min.js"></script>
   

3. Make sure you have a valid list(s) in HTML and that you can identify and select

    <ul id="webTicker">
    	<li>This List Item will scroll infintely</li>
    	<li>And this one will follow it</li>
    	<li>Finally when it goes out of screen, it will queue again at the end</li>
    </ul>
   

4. In your Javascript file, select with jQuery the list you want to convert to a ticker, and run the webTicker function.

    $('#webTicker').webTicker();
   

WebTicker is now activated on the list with id 'webTicker'.

###Settings {#settings}

When initializing the web ticker you may pass parameters to modify the settings of the web ticker. This is completely optional and used to meet your specific needs.

###Methods {#methods}

Methods can be called using javaScript on the element of the web ticker. The below table illustrates the available methods.

###Styling {#styling}

Styling the WebTicker is pretty much up to you as a developer, however the WebTicker does alter the dom slightly, and

###Markup Explained {#markup-explained}

The final mark up would look something like the below:

<div class="tickercontainer">
	<div class="mask">
		<ul id="WebTicker">
			<li class="ticker-spacer"></li>
			<li>This List Item will scroll infintely</li>
			<li>And this one will follow it</li>
			<li class="last" >Finally when it goes out of screen, it will queue again at the end</li>
		</ul>
		<span class="tickeroverlay-left">&nbsp;</span>
		<span class="tickeroverlay-right">&nbsp;</span>
	</div>
</div>

Elements Explained: