Skip to content

Commit

Permalink
[#511] Updates readme, removes time-specific information
Browse files Browse the repository at this point in the history
  • Loading branch information
rwaldron committed May 15, 2011
1 parent 3c3b7c6 commit af3e323
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions readme.md
@@ -1,36 +1,31 @@
PopcornJS
Popcorn.js
=============
The HTML5 <video> framework
The HTML5 Video Framework

Demos
------------
* Original Mozilla Summit Demo: <http://popcornjs.org/demos/semantic_video>
* Brendan Eich Demo: <http://popcornjs.org/demos/brendan_eich> (made with butter)

Overview
-------------
Popcorn.js is an event system for < video >, with strong syntactic sugar for chaining < video > methods and adding events to the timeline.
Popcorn.js is an event and timeline programming framework for HTML5 Media. For developer information, documentation and plugin demos, visit http://popcornjs.org. For video blogs and updates on Mozilla's Open Video Lab, visit http://webmademovies.org/.

Popcorn is a JavaScript Function that wraps the native < video > element and returns a Popcorn object which;

1. maintains a reference to the original HTMLVideoElement
2. provides a normalized interface to the < video > elements native methods and properties.
3. adds a special data property which contains meta data about the <video> (this is where the magic happens)

By normalizing the native methods, the framework allows developers to write chainable function executions off the returned Popcorn object.

API
-------------
We have begun API documentation here: https://gist.github.com/729213#file_popcorn_api.js
Documentation is available at http://popcornjs.org/documentation


Plugin Factory
-------------
Popcorn also offers a plugin factory. Popcorn plugins are a way for developers to wrap functionality that responds to a point in a video.

Take a look at our growing gallery of officially supported plugins: http://popcornjs.org/plugins


Roadmap
-------------
We are working on the 0.3 & 1.0 Roadmaps at http://etherpad.mozilla.com:9000/popcornjs
The project can be contributed to and followed here: https://webmademovies.lighthouseapp.com/projects/63272-popcornjs/overview


Changelog
-------------
A changelog can be found here: https://webmademovies.lighthouseapp.com/projects/63272/changelog
A changelog can be found here: https://webmademovies.lighthouseapp.com/projects/63272/changelog

0 comments on commit af3e323

Please sign in to comment.