From b03b2868a9a96f21331533c720e1c783b988c985 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nil=C3=A9ane?= <914451+nileane@users.noreply.github.com> Date: Wed, 19 Jul 2023 13:55:31 +0200 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index e362850..66ae9bf 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,13 @@ # Tangerine UI for Mastodon 🍊🐘 -Tangerine UI is a redesign of Mastodon's Web interface, using just CSS. +A Tangerine redesign for Mastodon's Web UI, using just CSS. -Make your Mastodon Web interface a friendlier place. Tangerine UI features a soft orange palette, a bubblier look, and a more compact timeline that should be easier on your eyes. Also, Tangerine UI supports both dark and light modes. - -* [Screenshots](#2-variants) -* [How to use](#how-to-use) -* [Things to know](#things-to-know) - -## Live demo at [nileane.fr](https://nileane.fr) +* Live demo at [nileane.fr](https://nileane.fr) * [See the announcement post](https://nileane.fr/@nileane/110691663040709608) on Mastodon -## 2 variants +## Variants -### 🍊 Tangerine +### Tangerine 🍊 Default variant for Tangerine UI, featuring a soft orange palette. ![a profile page on Mastodon featuring Tangerine UI in light mode](https://github.com/nileane/TangerineUI-for-Mastodon/assets/914451/77f49e2a-74c7-4d94-a427-c991289f2383) @@ -21,7 +15,7 @@ Default variant for Tangerine UI, featuring a soft orange palette. ![TangerineUI Mobile](https://github.com/nileane/TangerineUI-for-Mastodon/assets/914451/b10f3e72-0a58-4b0d-8f00-f7210958483c) -### đŸĒģ Purple +### Purple đŸĒģ For those of you who like Tangerine UI but want to stick to Mastodon's purple palette. ![a profile page on Mastodon featuring Tangerine UI's purple variant in light mode](https://github.com/nileane/TangerineUI-for-Mastodon/assets/914451/f3ab51d2-c94d-4192-a1c8-6d15b0d9025a) @@ -32,19 +26,23 @@ For those of you who like Tangerine UI but want to stick to Mastodon's purple pa ## How to use **Tangerine UI is contained in a single CSS file.** -* To use on your instance, simply copy & paste the contents of [`TangerineUI.css`](https://github.com/nileane/TangerineUI-for-Mastodon/blob/main/TangerineUI.css) to the **Custom CSS** field in the administration panel on your Mastodon instance (Navigate to https://*domain*/admin/settings/appearance). +* To use on your instance, copy & paste the contents of [`TangerineUI.css`](https://github.com/nileane/TangerineUI-for-Mastodon/blob/main/TangerineUI.css) to the **Custom CSS** field in the administration panel on your Mastodon instance (Navigate to https://*domain*/admin/settings/appearance). * đŸĒģ For the purple variant, copy the contents of [`TangerineUI-purple.css`](https://github.com/nileane/TangerineUI-for-Mastodon/blob/main/TangerineUI-purple.css) instead. * ⚠ī¸ Caution: Using the 'Custom CSS' field to apply Tangerine UI will prevent all users on your instance from being able to choose another theme in their settings. Please make sure there is a consensus among your users for doing so. -* If you're not an admin, you can still use Tangerine UI using a browser extension (ie. [Stylus](https://add0n.com/stylus.html)). +* If you're not an admin, you can use Tangerine UI with a browser extension (ie. [Stylus](https://add0n.com/stylus.html)). -### Things to know +* [To be added: instructions on how to install Tangerine UI as an optional theme for your users on your instance] + +## Things to know * **Tangerine UI currently only supports Mastodon's single column layout**. The advanced view (multiple columns) will not be affected. * **Tangerine UI auto-switches from light to dark mode based on your OS preference**, whether you set your Mastodon theme to *Mastodon (Dark)* or *Mastodon (Light*). * Check your Mastodon instance version before using. The latest Mastodon release checked to be compatible is indicated in the CSS file header. * Glitch-soc and Hometown instance admins beware: Tangerine UI is currently only meant to be applied to Mastodon's vanilla Dark and Light themes. * If you are a user on a Glitch-soc or Hometown instance using a browser extension, first switch your instance to the Mastodon flavour before applying Tangerine UI. -* I have not yet adapted Tangerine to Mastodon's *High Contrast* theme setting. Please consider this if one or multiple of your users depend on it. + +## Accessibility +* I have not yet adapted Tangerine to Mastodon's *High Contrast* theme setting. Please consider that some of your users may depend on it. ## Credits 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 multiple parts of the redesign. The icon replacement implementations I have also adapted from Bird UI.