forked from serversideup/amplitudejs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6befafd
commit 99d5408
Showing
1 changed file
with
53 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,66 @@ | ||
| [](https://open.521dimensions.com/amplitudejs) | ||
| <p align="center"> | ||
| <a href="https://521dimensions.com/open-source/amplitudejs" target="_blank"> | ||
| <img src="https://521dimensions.com/img/open-source/amplitudejs/AmplitudeLogo-WithSlogan.svg" width="600" alt="AmplitudeJS Logo"> | ||
| </a> | ||
| </p> | ||
| <p align="center"> | ||
| <a href="https://gitter.im/521dimensions/amplitudejs" target="_blank"> | ||
| <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Gitter"> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/amplitudejs" target="_blank"> | ||
| <img src="https://badge.fury.io/js/amplitudejs.svg" alt="npm version"> | ||
| </a> | ||
| <a href="https://david-dm.org/521dimensions/amplitudejs" target="_blank"> | ||
| <img src="https://david-dm.org/521dimensions/amplitudejs.svg" alt="david-dm"> | ||
| </a> | ||
| <a href="https://raw.githubusercontent.com/521dimensions/amplitudejs/master/LICENSE" target="_blank"> | ||
| <img src="https://521dimensions.com/img/open-source/amplitudejs/license.svg" alt="MIT License"> | ||
| </a> | ||
| </p> | ||
|
|
||
| Amplitude.js is a lightweight javascript library that allows you to control the design of your media controls in your webpage -- not the browser. No dependencies (jQuery not required). Amplitude.js is available under the [MIT License](https://open.521dimensions.com/license.txt). | ||
| Amplitude.js is a lightweight JavaScript library that allows you to control the design of your media controls in your webpage -- not the browser. No dependencies (jQuery not required). Amplitude.js is available under the [MIT License](https://raw.githubusercontent.com/521dimensions/amplitudejs/master/LICENSE). | ||
|
|
||
| ## Demo | ||
| <p align="center"> | ||
| <a href="https://521dimensions.com/open-source/amplitudejs" target="_blank"> | ||
| <img src="https://521dimensions.com/img/open-source/amplitudejs/AmplitudeDemo.jpg" alt="MIT License" width="600"> | ||
| </a><br /> | ||
| Click the image above to go to the demo site or <a href="https://521dimensions.com/open-source/amplitudejs" target="_blank">click here</a>. | ||
| </p> | ||
|
|
||
|
|
||
| Click the image at the top to be taken to the demo site or [click here](https://open.521dimensions.com/amplitudejs). | ||
|
|
||
| ## Features | ||
| * Completely independent library (no jQuery required) | ||
| * 100% customizable design | ||
| * Real time audio visualizations | ||
| * Simple Soundcloud integration | ||
| * Live streams | ||
| * Call back functions for events | ||
| * Play/Pause | ||
| * Stop | ||
| * Next Song | ||
| * Previous Song | ||
| * Shuffle | ||
| * 100% customizable design of all player elements | ||
| * Single command install: `npm install amplitudejs` | ||
| * Multiple playlist support on single page | ||
| * Song meta data display | ||
| * Soundcloud integration | ||
| * Live streaming support | ||
| * Call back functions for events | ||
| * Play/Pause | ||
| * Stop | ||
| * Next Song | ||
| * Previous Song | ||
| * Shuffle | ||
|
|
||
| ## Documentation | ||
| We're huge believers in clear documentation. You can access the [latest documentation here](https://open.521dimensions.com/amplitudejs/docs). If you find errors or places for improvement, submit a pull request with the documentation located at `/docs/DOCUMENTATION.md`. The documentation site reads directly from the GitHub Repo. | ||
| # Installation | ||
| ##### Automatic install via `npm` | ||
| Download it via NPM to your existing project: | ||
| ```sh | ||
| npm install --save amplitudejs | ||
| ``` | ||
|
|
||
| ## Reporting Issues | ||
| You will see the file under `amplitudejs/dist/amplitude.js`. | ||
|
|
||
| If you are experiencing any issues or if you have a feature request, please [open up a new GitHub Issue](https://github.com/521dimensions/amplitudejs/issues/new) | ||
| ##### Manual download | ||
| Download the `amplitude.js` file from our releases here: https://github.com/521dimensions/amplitudejs/releases | ||
|
|
||
| Want to see if you can get a hold of us directly? Just join our Gitter chat and ask away: | ||
| ## Documentation & Usage | ||
| We're huge believers in clear documentation. You can access the [latest documentation here](https://521dimensions.com/open-source/amplitudejs/docs). If you find errors or places for improvement, submit a pull request with the documentation located at `/docs/DOCUMENTATION.md`. The documentation site reads directly from the GitHub Repo. | ||
|
|
||
|
|
||
| ## Reporting Issues | ||
|
|
||
| [](https://gitter.im/521dimensions/amplitudejs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| If you are experiencing any issues or if you have a feature request, please [open up a new GitHub Issue](https://github.com/521dimensions/amplitudejs/issues/new) |