diff --git a/README.md b/README.md index f584ba0..6a25180 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,25 @@ -# Tube Archivist Companion +![Tube Archivist Companion](assets/tube-archivist-companion-banner.png?raw=true "Tube Archivist Companion Banner") + +

Tube Archivist Companion for your Browser

+
+tubearchivist-firefox +tubearchivist-chrome +
+ +## Core Functionality +A browser extension to bridge YouTube with [Tube Archivist](https://github.com/tubearchivist/tubearchivist). This extension allows you to do the following: +- Add your Tube Archivist connection details in the addon popup +- Add a download button to the popup for YouTube links +- Add a subscribe button to subscribe to channels and playlists ![popup screenshot](assets/screenshot.png?raw=true "Tube Archivist Companion Popup") -A browser extension to bridge YouTube with your Tube Archivist service. - ## Install - Firefox: The addon is available on the [Extension store](https://addons.mozilla.org/addon/tubearchivist-companion/). - Chrome: The addon is available on the [Chrome Web Store](https://chrome.google.com/webstore/detail/tubearchivist-companion/jjnkmicfnfojkkgobdfeieblocadmcie). ## Update -After a new release here on GitHub, you'll get updates automatically in your browser. For Firefox this usually takes 1-2 hours, for Chrome 2-3 days, so please be patient. +After a new release here on GitHub, you'll get updates automatically in your browser. Due to the verification process, for Firefox this usually takes 1-2 hours, for Chrome 2-3 days. ## Permissions - **Access your data for www.youtube.com**: Needed for the addon to know your current page on YouTube to send the link to Tube Archivist. @@ -22,12 +32,6 @@ After a new release here on GitHub, you'll get updates automatically in your bro A green checkmark will appear next to the *Save* button if your connection is working. -## All great things start small -This extension allows you to do the following: -- Add your Tube Archivist connection details in the addon popup -- Add a download button to the popup for YouTube links -- Add a subscribe button to subscribe to channels and playlists - ## Test this extension Use the correct manifest file for your browser. Either rename the browser specific file to `manifest.json` before loading the addon or symlink it to the correct location, e.g. `ln -s manifest-firefox.json manifest.json`. - Firefox diff --git a/assets/tube-archivist-companion-banner.png b/assets/tube-archivist-companion-banner.png new file mode 100644 index 0000000..cecdc7a Binary files /dev/null and b/assets/tube-archivist-companion-banner.png differ