Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marklieberman committed Jul 29, 2021
1 parent 1473df1 commit de4d4de
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,20 @@ Add a browser action that sends the tab or a URL to youtube-dl.
This addon is a simple GUI frontend to youtube-dl, available in the browser. A companion application is required to
manage communication between the browser and youtube-dl. See the [User Guide](https://github.com/marklieberman/youtube-dl-button/wiki/User-Guide) for an overview of the interface and features.

<img src="https://raw.githubusercontent.com/wiki/marklieberman/youtube-dl-button/images/popup-readme.png" height="400"/>
### Notable Features

* Queue system lets you download multiple videos in the background.
* View youtube-dl's console output in your browser.
* Optionally pass your browser's cookies to youtube-dl when downloading files from youtube.com.
* Update youtube-dl to latest version with a single click.

<img src="https://raw.githubusercontent.com/wiki/marklieberman/youtube-dl-button/images/popup-readme-2.png" height="400"/>

## Build

### Web-Ext

The web-ext can be built using `npm run build` which will produce a zip in dist/. You must [sign the addon on AMO](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/Distribution) before it can be installed in Firefox. Alternatively, a signed .xpi is available under Releases.
The web-ext can be built using `npm run dist` which will produce a zip in dist/. You must [sign the addon on AMO](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/Distribution) before it can be installed in Firefox. Alternatively, a signed .xpi is available under Releases.

### Native App

Expand All @@ -25,4 +32,4 @@ Instructions for installing the native app and youtube-dl.exe are [in the Wiki](

## Contributing

This project could use 1) a cross-platform native-app to add support for Linux and MacOS, 2) an installer to create manifest and registry entries automatically, ~~and 3) an auto-update feature to grab new versions of youtube-dl.exe~~. Any contributions would be appreciated and I would publish the addon on AMO once these features are available.
This project could use 1) a cross-platform native-app to add support for Linux and MacOS, and 2) an installer to create manifest and registry entries automatically. Any contributions would be appreciated and I would publish the addon on AMO once these features are available.

0 comments on commit de4d4de

Please sign in to comment.