Skip to content

Commit

Permalink
README.md: Add links for api.md & design.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xqq committed Oct 27, 2016
1 parent 9b5f143 commit 2dcd9f5
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

flv.js
======
An HTML5 Flash Video (FLV) Player written in pure JavaScript without Flash. LONG LIVE FLV!

This project, inspired by [hls.js][], relies on [Media Source Extensions][] to work.

Overview
--------
## Overview
flv.js works by transmuxing FLV file stream into ISO BMFF (Fragmented MP4) segments, followed by feeding mp4 segments into an HTML5 `<video>` element through [Media Source Extensions][] API.

flv.js is written in [ECMAScript 6][], transpiled into ECMAScript 5 by [Babel Compiler][], and bundled with [Browserify][].
Expand All @@ -16,17 +16,15 @@ flv.js is written in [ECMAScript 6][], transpiled into ECMAScript 5 by [Babel Co
[Babel Compiler]: https://babeljs.io/
[Browserify]: http://browserify.org/

Features
--------
## Features
- FLV container with H.264 + AAC codec playback
- Multipart segmented video playback
- HTTP FLV low latency live stream playback
- FLV over WebSocket live stream playback
- Compatible with Chrome, FireFox, Safari 10, IE11 and Edge
- Extermely low overhead, and hardware accelerated by your browser!

Build
-----
## Build
```bash
npm install # install dev-dependences
npm install -g gulp # install build tool
Expand All @@ -35,8 +33,7 @@ gulp release # packaged & minimized js will be emitted in dist folder

[cnpm](https://github.com/cnpm/cnpm) mirror is recommended if you are in Mainland China.

Getting Started
---------------
## Getting Started
```html
<script src="flv.min.js"></script>
<video id="videoElement"></video>
Expand All @@ -54,8 +51,13 @@ Getting Started
</script>
```

License
-------
## API and Configuration
See [api.md](docs/api.md)

## Design
See [design.md](docs/design.md)

## License
```
Copyright (C) 2016 Bilibili. All Rights Reserved.
Expand Down

0 comments on commit 2dcd9f5

Please sign in to comment.