Skip to content

Commit

Permalink
re-structure project, add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
grmat committed May 8, 2018
1 parent 20ba727 commit 1b41ddf
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web-ext-artifacts
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# open-with

A simple WebExtension to play back media in an external player.

## Compatibilty

*open-with* was originally intended to use [mpv] via the [youtube-dl] hook for a long list of [supported sites]. However, it will also work with other media players with [M3U] support, e.g. VLC, for direct media URLs.

## About

There have been addons on [AMO] prior to the release of *open-with*, but they depend on [native-messaging]. This WebExtension is designed to work on its own, without the need to install native messaging software on the host.

This is achieved by creating a plain text file with the M3U header, paste the current link into it and open the downloaded M3U playlist in your preferred media player.

![Screenshot](screenshot.png)

## Credits

This project is licensed under the [GPL]. The used [icon] is from Mozilla's [Photon] collection and licensed under the [MPL].

<!-- References -->
[AMO]: https://addons.mozilla.org/
[GPL]: COPYING
[icon]: src/icons/play-16.svg
[m3u]: https://en.wikipedia.org/wiki/M3U
[MPL]: https://www.mozilla.org/en-US/MPL/2.0/
[mpv]: https://mpv.io/
[native-messaging]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Native_messaging
[Photon]: https://design.firefox.com/icons/viewer/#play
[supported sites]: https://rg3.github.io/youtube-dl/supportedsites.html
[youtube-dl]: https://youtube-dl.org/

Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes
2 changes: 1 addition & 1 deletion manifest.json → src/manifest.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"description": "Open current URL in external application.",
"description": "Play media on current URL in external application.",
"manifest_version": 2,
"name": "open-with",
"version": "1.0",
Expand Down
File renamed without changes.

0 comments on commit 1b41ddf

Please sign in to comment.