overhaul readme.md

This commit is contained in:
ItsVipra 2023-05-28 12:18:37 +02:00
parent c0f00aa45d
commit 7f5e1d7934
4 changed files with 58 additions and 13 deletions

View file

@ -1,27 +1,72 @@
# ProToots (v0.99)
# ProToots (v1.0)
A Firefox extension which displays an author's pronouns next to their name on Mastodon.
![A Mastodon screenshot showing off pronouns next to a person's name](documentation/firefox_ehHwJufMau.png)
![A Mastodon screenshot showing off pronouns next to a person's name](documentation/example_screenshot.png)
---
## Download/Installation
### ⚠️ This is a **pre-release, temporary extension**! It will be **removed when you restart your browser**! ⚠️
The extension is available on the firefox store!
We're working on a proper firefox store release already.
[<img src="documentation/get-the-addon-178x60px.png">](https://addons.mozilla.org/en-US/firefox/addon/protoots/)
To install go to [the releases page](https://github.com/ItsVipra/ProToots/releases) and follow the instructions there.
Alternatively you can download an unsigned version from the [releases page](https://github.com/ItsVipra/Protoots/releases).
---
## Known issues
- Pronouns are not displayed on all notifications. See #25
- Pronouns are not displayed in the direct messages tab. See #26
- Pronouns on expanded posts are only shown if they have been cached before.
- Pronouns are not displayed on replies of an expanded post. See #27
---
## FAQ
Why does it need permission for all websites?
### Why does ProToots 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.
## setup
### Why can't i see any ProPlates?
- 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
- run the extension with `web-ext run -u -u="yourinstancehere"`
> It is likely your instance is not supported. This is because forks of Mastodon all work slightly differently and we cannot account for every version out there.
> If ProToots isn't working on your instance please tell your admins to contact us here on Github.
### ProPlates don't have a background/low contrast on my instance.
> Mastodon does not provide set variables for element colors, so we have to adjust the plate styling to each theme. If they're not displaying correctly please tell your admins to [follow these steps to style ProPlates](#how-do-i-style-proplates-to-correctly-display-on-my-themes)
### Somebody has added/changed pronouns, why is ProToots still showing no/their old pronouns?
> In order to strain your instance less pronouns are cached for 24h, so it might take up to a day to see this change reflected.
### Why does the ProPlate just show a link?
> When an author only provides their pronouns as a pronouns.page link we display that instead. In the future we'll be able to extract pronouns from the given link. (See #7)
---
## Instance admin info
### Protoots aren't working on my instance
> what protoots needs (data-id, classnames)
> issue/pull-request for custom schema
### How do I style ProPlates to correctly display on my themes?
> You can set their background-color and color attribute for each theme.
> To do this simply add some CSS to your server. [Here's how.](https://fedi.tips/customising-your-mastodon-servers-appearance/)
> See [our default styles](/src/styles/proplate.css) for reference.
---
## Developer setup
- Clone the repository
- [Install web-ext](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/#installation-section) and [set it up](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/#using-web-ext-section)
- Mess around with with [protoots.js](/src/content_scripts/protoots.js)
- Trans rights!

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.3 KiB