kopia lustrzana https://github.com/lartsch/FediAct
Update README.md
Lartsch
GitHub
rodzic
0cb501a508
commit
b16e0d4aed
65
README.md
65
README.md
|
|
@ -1,4 +1,4 @@
|
|||
# FediFollow (Beta)
|
||||
# FediFollow (Beta v0.5.0)
|
||||
A Chrome/Firefox extension that simplifies following and post interactions on other Mastodon instances than your own by intelligently redirecting you to your instance and utilizing the local API to resolve the content. If enabled, the extension automatically performs the desired action (follow, boost, favourite for now).
|
||||
|
||||
Should work for all updated Chromium browsers, updated Firefox, as well as Kiwi browser on Android. Currently only Mastodon 3 + 4 in different flavors are supported as far as I tested. Support for other Fediverse software / versions / flavors might be added in the future. Feel free to create pull requests / issues. This is my first proper browser extension so please bear with my awful JS skills.
|
||||
|
|
@ -8,20 +8,23 @@ Should work for all updated Chromium browsers, updated Firefox, as well as Kiwi
|
|||
* [Installation](#installation)
|
||||
* [Setup](#setup)
|
||||
* [Screenshots / GIFs](#screenshots--gifs)
|
||||
* [Manual installation](#manual-installation)
|
||||
* [Additional notes](#additional-notes)
|
||||
* [How it works](#how-it-works)
|
||||
* [Todos / Planned features](#todos--planned-features)
|
||||
|
||||
## Installation
|
||||
Right now, this needs to be installed in debugging / developer mode. Soon it will be available on Chrome Webstore / Firefox addon store.
|
||||
1. Download the [latest release](https://github.com/Lartsch/FediFollow-Chrome/releases/latest) for your browser (chrome or firefox)
|
||||
### Chrome
|
||||
2. Unzip the downloaded file somewhere
|
||||
3. Go to your Chrome extension page (URL: chrome://extensions) and enable developer mode
|
||||
4. Click the "Load unpacked" button and then select the unzipped folder (should be "fedifollow-X.X.X-chrome")
|
||||
### Firefox
|
||||
2. Open the debugging page (URL: about:debugging)
|
||||
3. Select "This Firefox"
|
||||
4. Click the "Load Temporary Add-on" button and then select the downloaded Firefox ZIP file
|
||||
|
||||
[link-chrome]: https://chrome.google.com/webstore/detail/fedifollow/lmpcajpkjcclkjbliapfjfolocffednm 'Version published on Chrome Web Store'
|
||||
[link-firefox]: https://addons.mozilla.org/en-US/firefox/addon/fedifollow/ 'Version published on Mozilla Add-ons'
|
||||
|
||||
[<img src="https://raw.githubusercontent.com/alrra/browser-logos/90fdf03c/src/chrome/chrome.svg" width="48" alt="Chrome" valign="middle">][link-chrome] [<img valign="middle" src="https://img.shields.io/chrome-web-store/v/lmpcajpkjcclkjbliapfjfolocffednm.svg?label=%20">][link-chrome] and other Chromium browsers (OUTDATED, v0.5.0 currently in review)
|
||||
|
||||
[<img src="https://raw.githubusercontent.com/alrra/browser-logos/90fdf03c/src/firefox/firefox.svg" width="48" alt="Firefox" valign="middle">][link-firefox] [<img valign="middle" src="https://img.shields.io/amo/v/fedifollow.svg?label=%20">][link-firefox] (soon including Firefox Android)
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> **If the webstore releases are outdated, you can use the [manual installation method](#manual-installation) to install the latest version**
|
||||
|
||||
## Setup
|
||||
|
||||
|
|
@ -36,25 +39,22 @@ Right now, this needs to be installed in debugging / developer mode. Soon it wil
|
|||
```
|
||||
- Required: Hit "Submit" to update your settings
|
||||
|
||||
> **Note**
|
||||
> 1. Currently supports external Mastodon instances v3 + v4
|
||||
> - I have not tested if Mastodon v3 works as home instance! In general, Mastodon v4 support is the main objective.
|
||||
> 2. The whitelist mode can be useful if you do not want the extension to run basic checks on every site (since it needs to determine if it is a Mastodon site). Not sure if the blacklist feature is good for anything but I still included it.
|
||||
> 3. It can have several reasons why a redirection/instance might not work:
|
||||
> - You are not logged in to your home instance (can't fix, log in)
|
||||
> - There are instances that use custom layouts/flavours (additional identifiers need to be added to extension)
|
||||
> - Instance chose to hide the follow button when not logged in (not supported yet)
|
||||
> - It's not a Mastodon instance (not supported yet)
|
||||
> - Element identifiers might change over time (extension needs to be updated)
|
||||
> - Your home instance is blocked by the external instance (can't fix, obviously)
|
||||
>
|
||||
> So please be aware, that this extension can fail in some cases. Feel free to submit pull requests / issues.
|
||||
|
||||
## Screenshots / GIFs
|
||||
|
||||
|
||||
|
||||
|
||||
## Manual installation
|
||||
1. Download the [latest Github release](https://github.com/Lartsch/FediFollow-Chrome/releases/latest) for your browser (chrome or firefox)
|
||||
### Chrome
|
||||
2. Unzip the downloaded file somewhere
|
||||
3. Go to your Chrome extension page (URL: chrome://extensions) and enable developer mode
|
||||
4. Click the "Load unpacked" button and then select the unzipped folder (should be "fedifollow-X.X.X-chrome")
|
||||
### Firefox
|
||||
2. Open the debugging page (URL: about:debugging)
|
||||
3. Select "This Firefox"
|
||||
4. Click the "Load Temporary Add-on" button and then select the downloaded Firefox ZIP file
|
||||
|
||||
## How it works
|
||||
Some basic explanations how the addon works...
|
||||
### General
|
||||
|
|
@ -82,6 +82,21 @@ Some basic explanations how the addon works...
|
|||
- This gives us the actual URL of the post on its home instance for using as the search string (even if the post is from another external instance than the external instance it is viewed on)
|
||||
- If all worked out, we build our search string and redirect to your home instance with the value as URL parameter then continue as explained in "General"
|
||||
|
||||
## Additional notes
|
||||
|
||||
1. Currently supports external Mastodon instances v3 + v4
|
||||
- I have not tested if Mastodon v3 works as home instance! In general, Mastodon v4 support is the main objective.
|
||||
2. The whitelist mode can be useful if you do not want the extension to run basic checks on every site (since it needs to determine if it is a Mastodon site). Not sure if the blacklist feature is good for anything but I still included it.
|
||||
3. It can have several reasons why a redirection/instance might not work:
|
||||
- You are not logged in to your home instance (can't fix, log in)
|
||||
- There are instances that use custom layouts/flavours (additional identifiers need to be added to extension)
|
||||
- Instance chose to hide the follow button when not logged in (not supported yet)
|
||||
- It's not a Mastodon instance (not supported yet)
|
||||
- Element identifiers might change over time (extension needs to be updated)
|
||||
- Your home instance is blocked by the external instance (can't fix, obviously)
|
||||
|
||||
So please be aware, that this extension can fail in some cases. Feel free to submit pull requests / issues.
|
||||
|
||||
## Todos / Planned features
|
||||
- Add support for post interactions (DONE)
|
||||
- Support executing the intended action after redirect (DONE)
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue