diff --git a/README.md b/README.md index 5984625..8f5b877 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ProToots (v1.0) +# ProToots (v1.0.2) 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/example_screenshot.png) @@ -17,10 +17,10 @@ Alternatively you can download an unsigned version from the [releases page](http ## Known issues -- Pronouns are not displayed on all notifications. See #25 -- Pronouns are not displayed in the direct messages tab. See #26 +- Pronouns are not displayed on all notifications. See [#25](https://github.com/ItsVipra/ProToots/issues/25) +- Pronouns are not displayed in the direct messages tab. See [#26](https://github.com/ItsVipra/ProToots/issues/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 +- Pronouns are not displayed on replies of an expanded post. See [#27](https://github.com/ItsVipra/ProToots/issues/) --- @@ -32,20 +32,21 @@ Alternatively you can download an unsigned version from the [releases page](http ### Why can't i see any ProPlates? -> 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. +> 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) +> 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. +> 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. +> Alternatively you can simply hit the "Reset cache" button in the addon settings. ### 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) +> 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](https://github.com/ItsVipra/ProToots/issues/)) --- @@ -53,13 +54,15 @@ Alternatively you can download an unsigned version from the [releases page](http ### Protoots aren't working on my instance -> what protoots needs (data-id, classnames) -> issue/pull-request for custom schema +> Currently ProToots only looks for specific classes and IDs. If your instance has changed the name of those, ProToots will not find them. +> Especially the **parent div with id 'Mastodon'** is important, since without that no other code will run. +> Please open an issue with your server name and info on which names you've changed, so we can add support for your instance. +> We're also working on a way to more easily support many different types of fedi software, such as Misskey or Akkoma. See [#12](https://github.com/ItsVipra/ProToots/issues/12) ### 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/) +> 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. --- diff --git a/src/manifest.json b/src/manifest.json index b351d24..4d5307a 100644 --- a/src/manifest.json +++ b/src/manifest.json @@ -1,7 +1,7 @@ { "manifest_version": 2, "name": "ProToots", - "version": "1.0.1", + "version": "1.0.2", "icons": { "48": "icons/icon small_size/icon small_size.png",