aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoseph Benden2014-12-15 15:04:55 (GMT)
committerJoseph Benden2014-12-15 15:07:27 (GMT)
commitb1232a426c36a7b6bf29f872966a451d1fb1c16e (patch)
treeb085e328f6bb97d826460d603f0a17a4de8d664c
parent0b00b8de7324d08be0e3bab607ff15da632957e4 (diff)
downloadHLS-Streamer-JS-b1232a426c36a7b6bf29f872966a451d1fb1c16e.zip
HLS-Streamer-JS-b1232a426c36a7b6bf29f872966a451d1fb1c16e.tar.gz
HLS-Streamer-JS-b1232a426c36a7b6bf29f872966a451d1fb1c16e.tar.bz2
HLS-Streamer-JS-b1232a426c36a7b6bf29f872966a451d1fb1c16e.tar.xz
Initial README file.
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d5804d8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
1[![Dependency Status](https://gemnasium.com/jbenden/hls-streamer.png)](https://gemnasium.com/jbenden/hls-streamer)
2[![Code Climate](https://codeclimate.com/github/jbenden/hls-streamer/badges/gpa.svg)](https://codeclimate.com/github/jbenden/hls-streamer)
3HLS Streamer
4============
5
6HLS Streamer is a node.js project that enables one to browse their multimedia collection
7over their iPhone, iPad, or Mac OS X and stream the contents of their collection to their
8device using HTTP Live Streaming capabilities.
9
10Installation
11------------
12
13Installation is simple for the node.js part. However, a specially compiled version of
14FFMpeg is needed to handle the streaming aspects. Installation of FFMpeg is easily
15accomplished using [Homebrew](http://brew.sh/), for instance.
16
17 # git clone git@github.com:jbenden/hls-streamer.git
18 # cd hls-streamer
19 # npm install
20 # ./bin/devserver
21
22The available directories are configured inside of `apps/sidewalk/routes.coffee` on line
236. Feel free to modify this line to suite your multimedia collection. This should be
24abstracted out to a configuration file, it just hasn't happened yet.
25
26To-Do
27-----
28
29* Abstract available paths to a configuration file.
30* Include a line to build an optimized FFMpeg from Homebrew.
31