mirror of
https://github.com/tubearchivist/browser-extension.git
synced 2024-11-05 03:30:12 +00:00
add banner and tiles to readme
This commit is contained in:
parent
ff0e8c1185
commit
65f6fe3257
24
README.md
24
README.md
@ -1,15 +1,25 @@
|
||||
# Tube Archivist Companion
|
||||
![Tube Archivist Companion](assets/tube-archivist-companion-banner.png?raw=true "Tube Archivist Companion Banner")
|
||||
|
||||
<h1 align="center">Tube Archivist Companion for your Browser</h1>
|
||||
<div align="center">
|
||||
<a href="https://www.tilefy.me" target="_blank"><img src="https://tiles.tilefy.me/t/tubearchivist-firefox.png" alt="tubearchivist-firefox" title="TA Companion Firefox users" height="50" width="190"/></a>
|
||||
<a href="https://www.tilefy.me" target="_blank"><img src="https://tiles.tilefy.me/t/tubearchivist-chrome.png" alt="tubearchivist-chrome" title="TA Companion Chrome users" height="50" width="190"/></a>
|
||||
</div>
|
||||
|
||||
## 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
|
||||
|
BIN
assets/tube-archivist-companion-banner.png
Normal file
BIN
assets/tube-archivist-companion-banner.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 18 KiB |
Loading…
Reference in New Issue
Block a user