Skip to content

Commit 18c9224

Browse files
author
Steven Vancoillie
committed
chore(docs): re-order README.md
1 parent 8b52353 commit 18c9224

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

+22-12
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,15 @@
99
[npm-url]: https://www.npmjs.com/package/media-stream-library
1010

1111
Media Stream Library JS is an open-source JavaScript library to handle media
12-
stream transforms for Node & the Web.
13-
The primary purpose is to deal with RTP streams in a browser without
14-
the need to use plugins or Flash, but relying on the [Media Source Extensions](https://www.w3.org/TR/media-source/) standard, which is supported in all modern browsers.
12+
stream transforms for Node & the Web. The primary purpose is to deal with RTP
13+
streams in a browser without the need to use plugins or Flash, but relying on
14+
the [Media Source Extensions](https://www.w3.org/TR/media-source/) standard,
15+
which is supported in all modern browsers.
16+
17+
Although RTP streams is the main focus, the library is not limited to handling
18+
RTP streams, or to the browser. It is suited to handle streams of messages of
19+
any kind, and makes it easier to stitch together transformations from one message
20+
type to another. Contributions of new components/pipelines are always welcome.
1521

1622
_Note for IE11 users_: if you want to build the library yourself for IE11 instead
1723
of using the provided bundle, you need import from `dist/es5` with the following fix in webpack:
@@ -42,16 +48,20 @@ yarn add media-stream-library
4248

4349
## Usage
4450

45-
This library is not a full media player: the framework provides
46-
no video controls, progress bar, or other features typically
47-
associated with a media player. However, getting video to play
48-
in the browser is quite easy (check the browser example).
49-
There are currently no codecs included either, we rely on
50-
browser support for that.
51+
This library is not a full media player: the framework provides no video
52+
controls, progress bar, or other features typically associated with a media
53+
player. For a simple React-based player we refer to the [Media Stream
54+
Player](https://github.com/AxisCommunications/media-stream-player-js) library,
55+
which is built around this library.
56+
57+
However, getting video to play in the browser is quite easy (check the browser
58+
example). There are currently no codecs included either, we rely on browser
59+
support for that.
5160

52-
Although RTP streams is the main focus, the library is not limited
53-
to handling RTP streams. Contributions of new components/pipelines are
54-
always welcome.
61+
Although RTP streams is the main focus, the library is not limited to handling
62+
RTP streams, or to the browser. Its main focus is to handle streams of messages,
63+
and make it easier to stitch together transformations from one message type to
64+
another. Contributions of new components/pipelines are always welcome.
5565

5666
### Importing
5767

0 commit comments

Comments
 (0)