source: trunk/html5/readme.txt @ 1026

Revision 1026, 2.8 KB checked in by zach, 3 years ago (diff)

Minor update to readme

Line 
1JW Player for HTML5 Readme
2==========================
3
4Thanks for downloading the beta release of our JW Player for HTML5! This player fully skinnable and configurable and based on the new <video> tag found in HTML5. It is built using javascript (jQuery) and includes a seamless fallback to the popular JW Player for Flash.
5
6Currently, the HTML5 player is in beta. Certain functionalities that we consider essential are missing in this beta version, but will be included in the 1.0 release. We very much value your feedback (both bug reports and feature suggestions), so please let us know!
7
8http://www.longtailvideo.com/support/forums/jw-player
9
10
11
12License
13-------
14
15The JW Player for HTML5 will be released under an open source license, but we have not yet determined the license model to be used. In the interim, it is available under JW Player Personal Use and Evaluation License (PUEL). See the license.txt file in the same directory as this readme for more info.
16
17Under the terms of this license it can be used on a website for personal, educational, demonstration, or evaluation purposes.
18
19Note that using the JW Player for HTML5 does not affect the licensing terms for the JW Player for Flash if you are using the flash fallback.
20
21
22
23Getting started
24---------------
25
26To quickly get started, upload the contents of this ZIP to your webserver. Include the two javascripts in the <head> of your page(s). For example:
27
28  <script type="text/javascript" src="/scripts/jquery.js"></script>
29  <script type="text/javascript" src="/scripts/jquery.jwplayer.js"></script>
30
31Second, place this code where you want the video to appear, replacing the "poster" and "src" attributes with your own poster image and video:
32
33  <video height="270" id="player" poster="/files/bunny.jpg" src="/files/bunny.mp4" width="480">
34
35  <script type="text/javascript">
36    $('#player').jwplayer({
37      flashplayer:'files/player.swf',
38      skin:'files/five.xml'
39    });
40  </script>
41
42Make sure that all references (the two javascript files, your image and video, the player.swf and all files in the skin) are correct!
43
44
45
46Documentation
47-------------
48
49For more example setups and a complete reference of this player, visit the HTML5 Player section of our support website:
50
51http://www.longtailvideo.com/support/jw-player/jw-player-for-html5/
52
53Our support website also includes a forum. Please let us know if you run into any issues or have suggestions for enhancements:
54
55http://www.longtailvideo.com/support/forums/jw-player
56
57
58
59Developers
60----------
61
62Developers interested in modifying and/or contributing to the player should refer to the HTML5 Player section of our developer website:
63
64http://developer.longtailvideo.com/trac/wiki/HTML5Overview
65
66This page contains more info about the player's internal architecture. It also contains references for compiling and testing the player.
67
68
69
Note: See TracBrowser for help on using the repository browser.