From 9c7e8c24f8273f70d743ae44034a01da352a88e9 Mon Sep 17 00:00:00 2001
From: ilotterytea <iltsu@alright.party>
Date: Fri, 2 May 2025 17:43:50 +0500
Subject: upd: readme

---
 README.md |  77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
 icon.png  | Bin 0 -> 4199 bytes
 2 files changed, 74 insertions(+), 3 deletions(-)
 create mode 100644 icon.png

diff --git a/README.md b/README.md
index b64fa94..a81ae18 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,83 @@
-# AlrightTV
+# ![](/icon.png) TinyEmotes
 
-a free, easy-to-install web emote provider for Twitch chats!
+Free, easy-to-install custom emote provider for IRC (and Twitch) platforms!
+The main goal of the project is to replicate full functionality of other emote providers *(7TV, BetterTTV and FrankerFaceZ)* and make it free for everyone. The design is inspired by booru imageboards.
 
-## Prerequisites
+## Features
+
++ Emote upload (GIF/WebP support, automatic resizing)
++ Moderation system (Reports, emote approval)
+
+> The project is in public beta. See [TODO list](https://github.com/users/ilotterytea/projects/11) for upcoming features.
+
+## Public TinyEmotes Instances
+
+| URL | Description | SFW/NSFW | Category |
+|-----|-------------|----------|----------|
+| [alright.party](https://alright.party) | Official TinyEmotes instance | NSFW | Mixed
+
+> PR if you know any instances running TinyEmotes.
+
+## Software supporting TinyEmotes
+
++ [Tinyrino](https://github.com/ilotterytea/tinyrino) - a Chatterino fork made by the author of TinyEmotes.
+
+> PR if you know any software supporting TinyEmotes.
+
+## Installation guide
+
+### Prerequisites
 
 + PHP >= 8.3
++ ImageMagick
 + MySQL/MariaDB
 
+### Step-by-step
+
+1. Clone the repository.
+2. Import `database.sql` to your database.
+3. Copy `src/config.sample.php` to `src/config.php` and set it up.
+4. Use reverse proxy *(Nginx, Apache, etc.)* for the project. See [configuration examples](#reverse-proxy-configurations).
+5. ???
+6. Profit! It should work.
+
+### Reverse proxy configurations
+
+<details>
+<summary>Basic Nginx configuration</summary>
+
+```nginx
+server {
+    server_name tinyemotesinstance.com;
+
+    root /www/tinyemotesinstance/public;
+    index index.php;
+
+    location / {
+	    try_files $uri $uri/ /index.php?$query_string;
+    }
+
+    location ~ \.php$ {
+	    include fastcgi_params;
+	    fastcgi_pass unix:/run/php/php-fpm.sock;
+	    fastcgi_index index.php;
+	    fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+    }
+
+    location ~* \.(js|css|png|jpg|jpeg|gif|webp|ico)$ {
+        expires 6M;
+        access_log off;
+        add_header Cache-Control "public";
+    }
+
+    location ~ /\. {
+        deny all;
+    }
+}
+```
+
+</details>
+
 ## License
 
 This project is under MPL-2.0 license. See [LICENSE](/LICENSE)
\ No newline at end of file
diff --git a/icon.png b/icon.png
new file mode 100644
index 0000000..82d59cc
Binary files /dev/null and b/icon.png differ
-- 
cgit v1.2.3