From cb715c4a4089ac9de764aeb34ced7dea75f079d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nil=C3=A9ane?= <914451+nileane@users.noreply.github.com> Date: Tue, 21 Nov 2023 16:31:49 +0100 Subject: [PATCH] Update README.md : new Features and Compatibility sections --- README.md | 44 +++++++++++++++++++++++++++++++++----------- 1 file changed, 33 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2afe2a4..858e5e2 100644 --- a/README.md +++ b/README.md @@ -23,24 +23,25 @@ Tangerine UI features a bubblier look, a more compact timeline, round avatars, a * [Install on a **Mastodon** instance](#installation-for-mastodon-admins) * [Install on a **Glitch-soc** instance](#installation-for-glitch-soc-admins) * [Install as a regular user](#installation-for-regular-users) -* [**Things to know**](#things-to-know) +* [**Compatibility**](#compatibility) * [**Accessibility**](#accessibility) * [**Credits**](#credits) * [**Support me**](#support-me-3) + ## Variants -* **Tangerine 🍊** +* **🍊 Tangerine** Default variant for Tangerine UI, featuring a soft orange palette. TangerineUI-tangerine -* **Purple πŸͺ»** +* **πŸͺ» Purple** For those of you who like Tangerine UI but want to stick to Mastodon's purple. TangerineUI-purple -* **Cherry πŸ’** +* **πŸ’ Cherry** I won't be held responsible if you end up licking your screen with this one. TangerineUI-cherry @@ -48,8 +49,29 @@ Tangerine UI features a bubblier look, a more compact timeline, round avatars, a ## Features -* **Thoughtful animations** - +* πŸ§‘β€πŸ”¬ **Support for the advanced web interface** + All variants of Tangerine UI support Mastodon's multi-column layout. + +TangerineUI-multicolumn + + +* πŸš€ **Thoughtful animations** + The rocket flies! + + + + +* 🌚 **Dark mode** + Tangerine UI automatically switches from light to dark mode based on your system or browser preference. + +* ⏺️ **Phosphor icons** + Tangerine UI uses a selection of icons from the beautiful [Phosphor](https://phosphoricons.com) icon family + +* πŸ” **Zoom on emojis** + Custom emojis are great, but they may be difficult to distinguish when they are overly detailed. Tangerine UI allows you to hover and pause over an emoji to enlarge it. + +* ✨ **and more** + ## List of instances that use Tangerine UI These are known instances that have enabled Tangerine UI for their users, either as the only theme, or as an optional theme. @@ -175,17 +197,17 @@ Even if you are not an admin on your instance, you can still use Tangerine UI wi πŸ’‘ Alternatively, if you wish to use a JavaScript browser extension, [@Write](https://github.com/Write) has written a ready-to-use UserScript to load Tangerine UI on any Mastodon instance. Check out [the TangerineUI-Userscript repository](https://github.com/Write/TangerineUI-Userscript) for instructions. -## Things to know -* **Tangerine UI currently only supports Mastodon's single column layout**. The advanced web interface (multiple columns) will not be affected. -* **Tangerine UI auto-switches from light to dark mode based on your OS preference**. -* Check your Mastodon instance version before using. The latest Mastodon release checked to be compatible is indicated in the CSS file header. +## Compatibility +* **Tangerine UI v2.x is compatible with instances running Mastodon 4.3 and above.** +* For instances running Mastodon 4.1.x or 4.2.x, use [**Tangerine UI v1.9.4**](https://github.com/nileane/TangerineUI-for-Mastodon/tree/v1.9.4) instead. + * ⚠️ The advanced web interface (multi-column layout) is not supported by Tangerine UI v1.9.4 +* Tangerine UI is **not** compatible with Mastodon 4.0.x and older. ## Accessibility Please consider that some of your users may depend on Mastodon's High Contrast theme before [setting Tangerine UI as the only theme](#install-tangerine-ui-as-the-only-theme-on-your-instance) on your instance. For this reason, unless you're running a single-user instance, I recommend [installing Tangerine UI as an optional/revertable theme](#install-tangerine-ui-as-an-optional-theme-on-your-instance-recommended) instead. ## Credits * The logo for Tangerine UI was designed by [Younis @younishd](https://younishd.fr). 🍊 -* Huge thanks to [Roni Laukkarinen](https://mementomori.social/@rolle) whose work on [Mastodon Bird UI](https://github.com/ronilaukkarinen/mastodon-bird-ui) I adapted for some parts of the design. ## Support me <3 If you enjoy Tangerine UI, jobless me would really appreciate a [tip πŸ’›](https://ko-fi.com/nileane)!