Skip to content

README.md

Latest commit

 

History

History
18 lines (12 loc) · 866 Bytes

README.md

File metadata and controls

18 lines (12 loc) · 866 Bytes

RadioFM

RadioFM is a web radio player

Building

Simply check out the source and run npm install and grunt at the root of the repo. Deploy the created build directory on any web server and you're set.

Contributing

The best way to contribute is to add new radios.

Radios should:

  • Have a radio_name and stream_url properties
  • Emit the new_radio event containing their object and their class name when they're instantiated so the config manager can save them for resuming the session later and the player can play the stream
  • Emit the new_rds event when queried for the current song and it has changed sinces the last query

You can find the Radio superclass in src/js/radio.js and use that as an example of all that should be implemented.

Additionaly, for now you'll have to add the radio manually to the radio selector in index.html