Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.6 KB

README.md

File metadata and controls

60 lines (37 loc) · 2.6 KB
Raw

Podlove Web Player Rails

Gem Version Build Status Code Climate Dependency Status

Brings the Podlove Web Player goodness to Rails.

Installation

Add this line to your application's Gemfile:

gem 'podlove-web-player-rails'

And then execute:

$ bundle
$ rails g podlove_web_player_rails:install

Add this line to app/assets/javascripts/application.js:

//= require podlove-web-player-rails

And add this line to app/assets/stylesheets/application.css:

*= require podlove-web-player

Or add this line to app/assets/stylesheets/application.css.scss:

@import "podlove-web-player";

Usage

Use the podloveaudio or podlovevideo helpers to inplement the audio or video player into your views. The helper is modelled after the shortcodes of the Podlove Web Player WordPress plugin and can be given all the options mentioned in it's FAQ as a hash. Basic usage would look like this:

<%= podloveaudio(src: 'http://mysite.com/mymedia.mp3', duration: '03:33', title: 'My track') %>

You can also read a description of all available options in the Documentation.

Versioning

The major, minor, and patch version numbers mirror the version of the Podlove Web Player itself. Should a gem bug be discovered, a 4th version identifier will be added and incremented.

Contributing

Feel free to open an issue ticket if you find something that could be improved. A couple notes:

  • If it's an issue pertaining the stylesheet or javascripts, please report it to the podlove-web-player project.
  • If the stylesheet or javascripts are outdated, feel free to open an issue and prod me to get that thing updated. You could, of course, also fork the gem and send me an pull request with the update.