From 5e99cc54e6eada6643bc77fd6a6f2e13b74b5c90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nil=C3=A9ane?= Date: Mon, 10 Jul 2023 21:01:20 +0200 Subject: [PATCH] Updated README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a3fed1a..4135cfc 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,21 @@ -# Tangerine UI for Mastodon 🍊 +# Tangerine UI for Mastodon 🍊🐘 *README still a WIP* Tangerine UI is a UI redesign I made for Mastodon's Web interface, using only pure CSS. +Turn your Mastodon web UI into a friendlier place. Tangerine 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. + ## How to use **Tangerine UI is contained in a single CSS file.** -To use on your instance, simply copy & paste the contents of [TangerineUI-single-colum.css](https://github.com/nileane/TangerineUI-for-Mastodon/blob/main/TangerineUIforMastodon-singlecolumnlayout.css) into the **Custom CSS** field in the administration panel on your Mastodon instance (Navigation to https:///admin/settings/appearance). +To use on your instance, simply copy & paste the contents of [TangerineUI-single-colum.css](https://github.com/nileane/TangerineUI-for-Mastodon/blob/main/TangerineUIforMastodon-singlecolumnlayout.css) to the **Custom CSS** field in the administration panel on your Mastodon instance (Navigate to https://*your instance domain*/admin/settings/appearance). If you're not an admin, you can still use Tangerine UI using a userstyle browser extension (ie. Stylish). -## Things to know +### Things to know * This is still pretty early. Things might not be styled properly in some places. Feel free to message me if you notice anything wonky! -* **Tangerine UI only supports the single column layout for now**. Nothing will happen if you have turned on the Advanced viem (multicolumn layout). +* **Tangerine UI only supports the single column layout for now**. The advanced view 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*). ## 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 replacements I use also come from Bird UI. \ No newline at end of file +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. \ No newline at end of file