From 944f53553267ef2096a9fae8720a4debee9ecb4c Mon Sep 17 00:00:00 2001 From: Gregory Ballantine Date: Wed, 2 May 2018 10:52:46 -0400 Subject: [PATCH] Updated readme --- README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 84 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5162d18..303ae80 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,85 @@ -# metaunix-player-js +# Metaunix-Player.js -An HTML/Javascript video player \ No newline at end of file +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 ` + + + +
+ + + + +``` + +#### 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