ProToots/README.md

28 lines
1.2 KiB
Markdown
Raw Normal View History

2023-05-24 16:47:04 +00:00
# ProToots (v0.99)
2023-05-25 13:37:24 +00:00
2023-05-24 16:47:04 +00:00
A Firefox extension which displays an author's pronouns next to their name on Mastodon.
2023-05-24 17:18:21 +00:00
![A Mastodon screenshot showing off pronouns next to a person's name](documentation/firefox_ehHwJufMau.png)
2023-05-24 16:47:04 +00:00
2023-05-24 17:20:01 +00:00
## Download/Installation
2023-05-25 13:37:24 +00:00
2023-05-24 18:05:34 +00:00
### ⚠️ This is a **pre-release, temporary extension**! It will be **removed when you restart your browser**! ⚠️
2023-05-25 13:37:24 +00:00
We're working on a proper firefox store release already.
2023-05-24 18:05:34 +00:00
To install go to [the releases page](https://github.com/ItsVipra/ProToots/releases) and follow the instructions there.
2023-05-24 16:47:04 +00:00
## FAQ
2023-05-25 13:37:24 +00:00
2023-05-24 16:47:04 +00:00
Why does it need permission for all websites?
> The addon needs to determine whether or not the site you are currently browsing is a Mastodon server. For that to work, it requires access to all sites. Otherwise, each existing Mastodon server would have to be explicitly added.
2023-05-25 13:37:24 +00:00
## setup
2023-05-24 16:47:04 +00:00
2023-05-25 13:37:24 +00:00
- install web-ext with `npm install --global web-ext`
- optionally:
- run `web-ext run --firefox-profile='$ProfileNameOfYourChoosing' --profile-create-if-mising`
- open that profile in firefox, log into fedi
- after that when you run `web-ext run -p='$ProfileNameOfYourChoosing'` you should be logged into your fedi account
2023-05-24 16:47:04 +00:00
- run the extension with `web-ext run -u -u="yourinstancehere"`