chinwag/ChinwagUI
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
Niléane 2023-07-10 21:01:20 +02:00
parent 07596ca2c0
commit 5e99cc54e6
No known key found for this signature in database
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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://<your instance domain>/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.
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.