Updated instructions and usage, and added contribution guidelines

CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Submitting Issues
+
+We use GitHub issues to track public bugs. If you are submitting a bug, please provide the contents of the HLS manifests (master and media manifests) to make it easier to reproduce the issue and update unit tests.
+
+# Contributing Code
+
+We follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html) so all contributions happen through pull requests. We actively welcome your pull requests:
+
+ 1. Fork the repo and create your branch from master.
+ 2. If you've added code that should be tested, add tests.
+ 3. If you've changed APIs, update the documentation.
+ 4. Ensure the test suite passes.
+ 5. Issue that pull request!
+
+Use 2 spaces for indentation rather than tabs. Thank you.
+
+When submit code changes your submissions are understood to be under the same MIT License that covers the project. Feel free to contact Eyevinn Technology if that's a concern.
+
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

README.md

@@ -1,11 +1,35 @@
+# hls-vodtolive
+
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Coverage Status](https://coveralls.io/repos/github/Eyevinn/hls-vodtolive/badge.svg?branch=master)](https://coveralls.io/github/Eyevinn/hls-vodtolive?branch=master)
 
-Node library for the conversion of HLS VOD to HLS Live
+Node library for the conversion of HLS VOD to HLS Live (A continuation and rebranding of vod-to-live.js library that is now deprecated)
+
+## Installation
+
+```
+npm install --save vod-to-live.js
+```
+
+## Usage
+
+This library load and parses HLS VOD manifests and generates HLS Live manifests. The example below loads one HLS VOD and then another HLS VOD that is appendend to the first one. The `getLiveMediaSequences(mediaseq)` returns HLS Live media sequence slices, and in the example below outputs the last live media sequence representation of the first VOD.
+
+```
+const HLSVod = require('@eyevinn/hls-vodtolive');
+const vod = new HLSVod('https://example.com/vod.m3u8');
+const vod2 = new HLSVod('https://example.com/vod2.m3u8');
+vod.load().then(() => {
+    // Get media sequence no 5 for bitrate 798000
+    console.log(vod.getLiveMediaSequences(0, '798000', 5));
+    return vod2.loadAfter(vod);
+}).then(() => {
+    console.log(vod.getLiveMediaSequences(vod.getLiveMediaSequencesCount(), '798000', 0));
+}).catch(console.error);
+```
+
+One use case for this library is to simulate a linear live HLS stream by concatenating HLS VODs together which live HLS manifests are generated from. The open source library [Channel Engine](https://github.com/Eyevinn/channel-engine) provides an example of this.
 
-(A continuation and rebranding of vod-to-live.js library that is now deprecated)
-
-A library that is used to slice on-demand audio and video packaged in Apple HLS streaming format
-into a list of HLS live media sequences, e.g:
+What this library does can be illustrated by this simplified example below:
 
 ```
 #EXTINF:9
@@ -92,26 +116,18 @@ segB2.ts
 segB3.ts
 ```
 
-One of the use cases for this library is when to "simulate" a simulcast of a TV channel based on
-a sequence of on-demand content (playlist). The video player will playback the playlist as one
-live HLS stream.
+# Authors
 
-## Example
+This project was started as vod-to-live.js in 2018 by Eyevinn Technology.
 
-    $ npm install --save vod-to-live.js
+## Contributors
 
-```
-const HLSVod = require('@eyevinn/hls-vodtolive');
-const vod = new HLSVod('https://example.com/vod.m3u8');
-const vod2 = new HLSVod('https://example.com/vod2.m3u8');
-vod.load().then(() => {
-    // Get media sequence no 5 for bitrate 798000
-    console.log(vod.getLiveMediaSequences(0, '798000', 5));
-    return vod2.loadAfter(vod);
-}).then(() => {
-    console.log(vod.getLiveMediaSequences(vod.getLiveMediaSequencesCount(), '798000', 0));
-}).catch(console.error);
-```
+- Jonas Rydholm Birmé (jonas.birme@eyevinn.se)
+- Alan Allard (alan.allard@eyevinn.se)
+
+# [Contributing](CONTRIBUTING.md)
+
+In addition to contributing code, you can help to triage issues. This can include reproducing bug reports, or asking for vital information such as version numbers or reproduction instructions. 
 
 # License (MIT)
 
@@ -123,3 +139,10 @@ The above copyright notice and this permission notice shall be included in all c
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+# About Eyevinn Technology
+
+Eyevinn Technology is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor.
+
+At Eyevinn, every software developer consultant has a dedicated budget reserved for open source development and contribution to the open source community. This give us room for innovation, team building and personal competence development. And also gives us as a company a way to contribute back to the open source community.
+
+Want to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se!