browser-extension/README.md

# Tube Archivist Companion

![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).

## 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.
- **Storage**: Needed to store your connection details, needed to store your last visited YouTube link within the browser.

## Setup
- **URL**: This is where your Tube Archivist instance is located. Can be a host name or a IP address, use a full URL with protocol, e.g. *http://*. 
- **Port**: Network port of TA.
- **API key**: You can find your API key on the settings page of your Tube Archivist instance. 

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
  - Open `about:debugging#/runtime/this-firefox`
  - Click on *Load Temporary Add-on*
  - Select the *manifest.json* file to load the addon. 
- Chrome / Chromium
  - Open `chrome://extensions/`
  - Toggle *Developer mode* on top right
  - Click on *Load unpacked*
  - Open the folder containing the *manifest.json* file.

## Compatibility
- Verify that you are running the latest version of Tube Archivist as the API is under development and will change.
- For testing this extension between releases, use the *unstable* builds of Tube Archivist, only for your tesing environment.

## Help needed
Join us on [Discord](https://discord.gg/AFwz8nE7BK) and help us improve and extend this project.
initial commit, extension in dedicated repo 2022-04-01 01:40:39 +00:00			`# Tube Archivist Companion`
add screenshot to readme 2022-04-03 14:59:20 +00:00
			`![popup screenshot](assets/screenshot.png?raw=true "Tube Archivist Companion Popup")`

project update, be more confident 2022-06-04 02:03:06 +00:00			`A browser extension to bridge YouTube with your Tube Archivist service.`
install instructions and permissions explained 2022-04-09 07:04:21 +00:00
			`## Install`
add chrome webstore link 2022-04-28 09:17:14 +00:00			`- 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).`
install instructions and permissions explained 2022-04-09 07:04:21 +00:00
			`## 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.`
add setup instructions 2022-04-16 05:45:03 +00:00			`- Storage: Needed to store your connection details, needed to store your last visited YouTube link within the browser.`

			`## Setup`
			`- URL: This is where your Tube Archivist instance is located. Can be a host name or a IP address, use a full URL with protocol, e.g. http://.`
			`- Port: Network port of TA.`
			`- API key: You can find your API key on the settings page of your Tube Archivist instance.`

			`A green checkmark will appear next to the Save button if your connection is working.`
initial commit, extension in dedicated repo 2022-04-01 01:40:39 +00:00
project update, be more confident 2022-06-04 02:03:06 +00:00			`## All great things start small`
			`This extension allows you to do the following:`
initial commit, extension in dedicated repo 2022-04-01 01:40:39 +00:00			`- Add your Tube Archivist connection details in the addon popup`
project update, be more confident 2022-06-04 02:03:06 +00:00			`- Add a download button to the popup for YouTube links`
			`- Add a subscribe button to subscribe to channels and playlists`
initial commit, extension in dedicated repo 2022-04-01 01:40:39 +00:00
			`## Test this extension`
a note about different manifest files 2022-04-02 05:16:11 +00:00			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`.
initial commit, extension in dedicated repo 2022-04-01 01:40:39 +00:00			`- Firefox`
			- Open `about:debugging#/runtime/this-firefox`
			`- Click on Load Temporary Add-on`
			`- Select the manifest.json file to load the addon.`
			`- Chrome / Chromium`
			- Open `chrome://extensions/`
			`- Toggle Developer mode on top right`
			`- Click on Load unpacked`
			`- Open the folder containing the manifest.json file.`

project update, be more confident 2022-06-04 02:03:06 +00:00			`## Compatibility`
			`- Verify that you are running the latest version of Tube Archivist as the API is under development and will change.`
			`- For testing this extension between releases, use the unstable builds of Tube Archivist, only for your tesing environment.`
initial commit, extension in dedicated repo 2022-04-01 01:40:39 +00:00
project update, be more confident 2022-06-04 02:03:06 +00:00			`## Help needed`
			`Join us on [Discord](https://discord.gg/AFwz8nE7BK) and help us improve and extend this project.`