Skip to content

Commit 1230817

Browse files
authored
Update README.md
1 parent 6328c56 commit 1230817

File tree

1 file changed

+40
-32
lines changed

1 file changed

+40
-32
lines changed

README.md

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,24 @@ Tangerine UI is a vibrant, fully-featured custom theme for Mastodon's Web UI tha
1212

1313
## Table of contents
1414

15-
* [**Variants**](#variants)
16-
* [**Features**](#features)
17-
* [**List of instances that use Tangerine UI**](#list-of-instances-that-use-tangerine-ui)
18-
* [**Compatibility**](#compatibility)
19-
* [**Installation**](#installation-for-mastodon-admins)
20-
* [Install on a **Mastodon** instance](#installation-for-mastodon-admins)
21-
* [Install on a **Glitch-soc** instance](#installation-for-glitch-soc-admins)
22-
* [Install as a regular user](#installation-for-regular-users)
23-
* [**Accessibility**](#accessibility)
24-
* [**Credits**](#credits)
25-
* [**Support me**](#support-me-3)
15+
1. [**Overview**](#overview)
16+
* [**Variants**](#variants)
17+
* [**Features**](#features)
18+
* [**List of instances that use Tangerine UI**](#list-of-instances-that-use-tangerine-ui)
19+
2. [**Compatibility**](#compatibility)
20+
6. [**Installation** for Mastodon instance admins](#installation-for-mastodon-admins)
21+
* [Install on a **Mastodon** instance](#installation-for-mastodon-admins)
22+
* [using the included script](#install-using-the-included-script)
23+
* [... or manually](#install-manually-without-the-included-script)
24+
* [Install on a **Glitch-soc** instance](#installation-for-glitch-soc-admins)
25+
7. [**Installation** for regular users](#installation-for-regular-users)
26+
8. [**Accessibility**](#accessibility)
27+
9. [**Credits**](#credits)
28+
10. [**Support me**](#support-me-3)
2629

30+
## Overview
2731

28-
## Variants
32+
### Variants
2933

3034
**🍊 Tangerine**
3135
Default variant for Tangerine UI, featuring a soft orange palette.
@@ -55,41 +59,41 @@ Soft turquoise palette that gives neon vibes at night.
5559
 
5660

5761

58-
## Features
62+
### Features
5963

60-
* 🧑‍🔬 **Support for the advanced web interface**
61-
All variants of Tangerine UI support Mastodon's multi-column layout.
64+
🧑‍🔬 **Support for the advanced web interface**
65+
All variants of Tangerine UI support Mastodon's multi-column layout.
6266

6367
<img width="1840" alt="Mastodon's advanced web interface featuring Tangerine UI" src="https://github.com/nileane/TangerineUI-for-Mastodon/assets/914451/bfa74219-bfef-46ec-9742-78165593e2a6">
6468

6569

66-
* 🚀 **Playful animations**
67-
The rocket flies!
70+
🚀 **Playful animations**
71+
The rocket flies!
6872

69-
<img width="600" alt="Clicking the Boost buttons makes the rocket icon seeming like it's taking off. Clicking the favorite button makes it bounce. Cliking the bookmark button makes it shake vertically." src="https://github.com/nileane/TangerineUI-for-Mastodon/assets/914451/31d41d04-6ef1-4ef0-80c3-b4b445ee98a1">
73+
<img width="600" alt="Clicking the Boost buttons makes the rocket icon seeming like it's taking off. Clicking the favorite button makes it bounce. Cliking the bookmark button makes it shake vertically." src="https://github.com/nileane/TangerineUI-for-Mastodon/assets/914451/31d41d04-6ef1-4ef0-80c3-b4b445ee98a1">
7074

7175

72-
* 🌚 **Dark mode**
73-
Tangerine UI automatically switches from light to dark mode based on your system or browser preference.[^1]
74-
[^1]: Tangerine UI uses the [`prefers-color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) CSS media feature to detect if you have requested a light or dark theme through an operating system setting or a user agent setting.
76+
<br>🌚 **Dark mode**
77+
Tangerine UI automatically switches from light to dark mode based on your system or browser preference.[^1]
78+
[^1]: Tangerine UI uses the [`prefers-color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) CSS media feature to detect if you have requested a light or dark theme through an operating system setting or a user agent setting.
7579

76-
* 💬 **Distinct look for DMs**
77-
It can be easy to mistake a DM for a regular post on Mastodon. Tangerine UI gives DMs a specific look, so they stand out in your timeline, and you don't make any embarrassing mistakes.
80+
💬 **Distinct look for DMs**
81+
It can be easy to mistake a DM for a regular post on Mastodon. Tangerine UI gives DMs a specific look, so they stand out in your timeline, and you don't make any embarrassing mistakes.
7882

79-
* 👁️ **Compact timeline**
80-
Avatars are aligned on the side, margins are properly reduced, and threads are easier to read.
83+
👁️ **Compact timeline**
84+
Avatars are aligned on the side, margins are properly reduced, and threads are easier to read.
8185

82-
* ✴️ **Phosphor icons**
83-
Tangerine UI uses a selection of icons from the beautiful [Phosphor](https://phosphoricons.com) icon family
86+
✴️ **Phosphor icons**
87+
Tangerine UI uses a selection of icons from the beautiful [Phosphor](https://phosphoricons.com) icon family
8488

85-
* 🔍 **Zoom on emojis**
89+
🔍 **Zoom on emojis**
8690
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.
8791

88-
* ✳️ **and more**
89-
Tangerine UI was designed with care and great attention to detail. Feel free to explore all the changes it brings to Mastodon's UI, and feel free to [message me](https://nileane.fr/@TangerineUI) if you ever have any feedback to share or [bugs to report](https://github.com/nileane/TangerineUI-for-Mastodon/issues). :)
92+
✳️ **and more**
93+
Tangerine UI was designed with care and great attention to detail. Feel free to explore all the changes it brings to Mastodon's UI, and feel free to [message me](https://nileane.fr/@TangerineUI) if you ever have any feedback to share or [bugs to report](https://github.com/nileane/TangerineUI-for-Mastodon/issues). :)
9094

9195

92-
## List of instances that use Tangerine UI
96+
### List of instances that use Tangerine UI
9397
This is a list of known Mastodon instances on which Tangerine UI has been installed, either as the only theme or as an optional theme.[^2]
9498
[^2]: If you're an admin and have installed Tangerine UI on your instance, **feel free to add yours to this list**. (Make a Pull Request, or just [DM me](https://nileane.fr/@tangerineui))
9599

@@ -165,7 +169,9 @@ This is a list of known Mastodon instances on which Tangerine UI has been instal
165169
Follow these instructions if you wish to add Tangerine UI as an available theme for your users on your instance.
166170
This will also allow you to set Tangerine UI as the default theme for your instance, while still letting your users change back to any of Mastodon's default themes in their Appearance settings.
167171

168-
#### Install using the included script
172+
<details>
173+
<summary><strong>Install using the included script</strong></summary>
174+
169175
Run the following commands as the `mastodon` user to install Tangerine UI using the [included script](https://github.com/nileane/TangerineUI-for-Mastodon/blob/main/install.sh.sample):
170176

171177
1. **Clone** the Tangerine UI repository
@@ -212,6 +218,8 @@ themes:
212218
> [!NOTE]
213219
> `./install.sh` can be run again to update Tangerine UI on your Mastodon instance.
214220
221+
</details>
222+
215223
#### Install manually (without the included script)
216224
217225
1. **Check your Mastodon version**. For Tangerine UI to work properly, you need to make sure you're installing the right version for your Mastodon instance. Please check the [Compatibility](#compatibility) section in this document before you proceed.

0 commit comments

Comments
 (0)