Updated readme

2018-05-02 10:52:46 -04:00 · 2018-05-02 10:52:46 -04:00 · 944f535532
commit 944f535532
parent b2bcf49e64
1 changed files with 84 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,85 @@
-# metaunix-player-js
+# Metaunix-Player.js

-An HTML/Javascript video player
+An HTML/Javascript video player - built as a jQuery plugin for easy use. The idea behind this project was to create an HTML5 video player that was very configurable and allowed for dynamic updates on a real website.
+
+## Getting Started
+
+Below you will learn how to get ready for an use this project.
+
+### Prerequisites
+
+#### Production
+
+You simply need to include `<script>` tags that point to jQuery and a copy of the compiled Javascript files.
+
+#### Development
+
+You will need node.js installed on your machine to compile assets and run tests. You will need to install the Grunt CLI package with `npm install -g grunt-cli`. The rest of the tools required should be easily installed by running `npm install`
+
+The list of tools installed will be:
+
+* Grunt
+* Grunt plugins for:
+    * Sass
+    * CoffeeScript
+    * Time (tracks how much time each task takes to run)
+    * Watch (for automatically re-running compilation steps)
+* Sass-lint
+
+### Usage
+
+#### Production
+
+Using this in a production environment (e.g. on a website), you will need to include this script, as stated above, create an HTML element, and then call the plugin in a second script, for example:
+
+```html
+<html>
+<head>
+  <title>My Site</title>
+  <script src="https://cdn.example.com/path/to/jQuery"></script>
+  <script src="https://cdn.example.com/path/to/player.js"></script>
+</head>
+<body>
+  <div class="my-player" />
+
+  <script>
+    $('.my-player').MUPlayer({
+      'use_default_css': true,
+      'video_width': '720px',
+      'video_sources': [
+        {
+          'link': 'http://techslides.com/demos/sample-videos/small.ogv',
+          'type': 'video/ogg',
+        },
+        {
+          'link': 'http://techslides.com/demos/sample-videos/small.mp4',
+          'type': 'video/mp4',
+        }
+      ]
+    });
+  </script>
+</body>
+</html>
+```
+
+#### Development
+
+Assuming you have the grunt-cli NPM package installed, `cd` to a clone of this repository and run `grunt`. The SASS and CoffeeScript assets should now compile, and you can use the provided index.html file for local testing.
+
+## Contributing
+
+If you notice anything about this project that could be improved, feel free to open up an Issue, clone this repository and create a Pull Request with those changes, or shoot me an email at gballantine555@gmail.com.
+
+Please, please, PLEASE be as detailed as possible if you notice any bugs or have feature requests. Copy the error/console output, suggest a possible way to implement a feature, give me something so I'm trying to tackle an issue blindly!
+
+## Versioning
+
+I will use [SemVer](http://semver.org/) for versioning this project - right now there are no versions available, but when I feel this project is ready to be used in any capacity, I'll start tagging releases.
+
+## Authors
+
+* **Gregory Ballantine** - [Gitea](https://git.metaunix.net/gballan)
+
+## License
+
+This project is licensed under the "Simplified" BSD License (aka BSD 2-Clause License) - see the LICENSE file for details