From 280feb3d4d6d111cf9e6f93353548eea68bec25a Mon Sep 17 00:00:00 2001
From: Saltssaumure <themes@saltssaumure.net>
Date: Wed, 3 Jul 2024 21:34:25 +0100
Subject: [PATCH] Update readme

---
 README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 65 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 68e91c6..d1790ba 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,65 @@
-# pios-chrome-theme
-wuh
+[github]:   https://github.com/Saltssaumure/pios-browser-theme
+[issues]:   https://github.com/Saltssaumure/pios-browser-theme/issues
+[license]:  https://github.com/Saltssaumure/pios-browser-theme/blob/main/LICENSE
+[discord]:  https://discord.gg/uy8nKQVatp
+
+[dl-chrome-theme]:      https://github.com/Saltssaumure/pios-browser-theme/releases/latest/download/piOS-chrome-theme.zip "Get latest release for Chrome"
+[dl-vivaldi-theme]:     https://github.com/Saltssaumure/pios-browser-theme/releases/latest/download/piOS-vivaldi-theme.zip "Get latest release for Vivaldi"
+[dl-vivaldi-custom]:    https://github.com/Saltssaumure/pios-browser-theme/releases/latest/download/piOS-vivaldi-custom.css "Get latest release for Vivaldi"
+
+[img-chrome-theme]:     https://img.shields.io/github/downloads/Saltssaumure/pios-browser-theme/piOS-chrome-theme.zip?color=purple&label=Downloads&style=flat-square
+[img-vivaldi-theme]:    https://img.shields.io/github/downloads/Saltssaumure/pios-browser-theme/piOS-vivaldi-theme.zip?color=purple&label=Downloads&style=flat-square
+[img-vivaldi-custom]:   https://img.shields.io/github/downloads/Saltssaumure/pios-browser-theme/piOS-vivaldi-custom.zip?color=purple&label=Downloads&style=flat-square
+[img-repo-size]:        https://img.shields.io/github/repo-size/Saltssaumure/pios-browser-theme?label=Repository&style=flat-square
+
+# piOS Browser Themes
+[![Chrome GitHub downloads][img-chrome-theme]][dl-chrome-theme]
+[![Vivaldi GitHub downloads][img-vivaldi-theme]][dl-vivaldi-theme]
+[![Total repository size][img-repo-size]][github]
+
+**_SUPERHOT piOS inspired themes for your browser._**
+
+Currently supported browsers:
+
+- Chrome
+- Vivaldi
+
+
+## Installation
+### Chrome
+<details><summary>Click to expand</summary>
+
+1. Download `piOS-chrome-theme.zip` from the [latest release][dl-chrome-theme].
+2. Unzip the file.
+3. Open a new tab and go to `chrome://extensions`.
+4. At the top right, slide the switch that says `Developer mode` to turn on Developer Mode.
+5. At the top left, click the `Load unpacked` button. Find the newly unzipped folder that you downloaded and select it.
+</details>
+
+
+### Vivaldi
+<details><summary>Click to expand</summary>
+
+1. Download `piOS-vivaldi-theme.zip` from the [latest release][dl-vivaldi-theme].
+2. Go to `Settings > Themes` in Vivaldi.
+3. Click the `Open Theme...` button and select the downloaded file.
+
+#### Additional CSS
+
+1. Download `piOS-vivaldi-custom.css` from the [latest release][dl-vivaldi-theme] into its own folder.
+2. Enter `vivaldi://experiments` into the address bar in Vivaldi.
+3. Enable `Allow CSS modifications`.
+4. Go to `Settings > Appearance > Custom UI Modifications`.
+5. Select the folder containing the file you downloaded.
+</details>
+
+
+## License
+
+This project is licensed under the [MIT license][license].
+
+
+## Questions or suggestions?
+
+- Post [an issue][issues] on GitHub.
+- Post in `#theme-support` on [my support server][discord].
\ No newline at end of file