From 812a6e18fc838c6b4981bd4210561b5782367430 Mon Sep 17 00:00:00 2001
From: HidemaruOwO <owner@v-sli.me>
Date: Thu, 10 Apr 2025 01:25:38 +0900
Subject: [PATCH] :books: Update README with detailed Puyoskey customization
 information (README.md)

---
 README.md | 75 ++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 44 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index c109620825..5069009b52 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,29 @@
 <div align="center">
 
 <img src="./docs/logo.png" height="150" />
-<h2>ぷよすきー</h2>
+<h2>ぷよすきー (Puyoskey)</h2>
 
-**🌎 [Puyoskey](https://git.v-sli.me/HidemaruOwO/puyoskey) is federated SNS based on Sharkey 🚀** 
+**🌎 [Puyoskey](https://git.v-sli.me/HidemaruOwO/puyoskey) is a customized federated SNS based on [Sharkey](https://joinsharkey.org/)** 
 
 </div>
 
-## Usage 💨
+## About Puyoskey 🦈
+
+Puyoskey is a customized version of Sharkey with specific UI modifications to enhance the user experience. Some of the key customizations include:
+
+- Simplified instance ticker display
+- Customized timeline interface
+- Enhanced server metrics visualization
+- Modified UI components
+
+See the complete list of customizations in our [customization documentation](./docs/customized.md).
+
+## Installation Guide 💨
 
 <details>
-<summary> Install depencies for AlmaLinux 9 Server ⛏️</summary>
+<summary> Install dependencies for AlmaLinux 9 Server ⛏️</summary>
 
-install cli depencies
+Install CLI dependencies:
 
 ```bash
 dnf install -y epel-release
@@ -25,7 +36,7 @@ dnf install -y git make automake gcc gcc-c++ kernel-devel kernel-headers ffmpeg
 dnf groupinstall -y "Development Tools"
 ```
 
-install Node.js and pnpm:
+Install Node.js and pnpm:
 
 ```bash
 curl -fsSL https://rpm.nodesource.com/setup_22.x | bash -
@@ -37,21 +48,21 @@ pnpm
 ```
 </details>
 
-- Manual Install
+### Manual Installation
 
-create user for puyoskey:
+Create user for Puyoskey:
 
 ```bash
 useradd -m -D puyoskey
 ```
 
-switch created user:
+Switch to created user:
 
 ```bash
 sudo -iu puyoskey
 ```
 
-clone the puyoskey repository, and copy the example configuration file:
+Clone the Puyoskey repository, and copy the example configuration file:
 
 ```bash
 git clone --recurse-submodules -b master https://git.v-sli.me/HidemaruOwO/puyoskey.git
@@ -60,15 +71,15 @@ pnpm install --frozen-lockfile
 cp .config/example.yml .config/default.yml
 ```
 
-build puyoskey:
+Build Puyoskey:
 
 ```bash
 pnpm run build
 ```
 
-- setup DB (if postgresql installed):
+### Database Setup (PostgreSQL)
 
-attach psql: 
+Attach to psql: 
 
 ```bash
 sudo -u postgres psql
@@ -82,26 +93,26 @@ ALTER DATABASE puyoskey OWNER TO puyoskey;
 \q
 ```
 
-edit configuration file:
+Edit configuration file:
 
 ```bash
 vim .config/default.yml
 ```
 
-create the schema:
+Create the schema:
 
 ```bash
 pnpm run init
 ```
 
-start puyoskey:
+Start Puyoskey:
 
 ```bash
 pnpm start
 ```
 
 <details>
-<summary>Run with systemd (you should change user as root)</summary>
+<summary>Run with systemd (you should change user to root)</summary>
 
 Create a file `/etc/systemd/system/puyoskey.service` containing:
 
@@ -127,14 +138,14 @@ Restart=always
 WantedBy=multi-user.target
 ```
 
-enable and run daemon service
+Enable and run daemon service:
 
 ```bash
 systemctl daemon-reload
 systemctl enable --now puyoskey.service
 ```
 
-- do you want periodic restart process?
+Optional: For periodic restart process
 
 Create a file `/etc/systemd/system/puyoskey.timer`:
 
@@ -164,7 +175,7 @@ ExecStart=/usr/bin/systemctl restart puyoskey.service
 WantedBy=multi-user.target
 ```
 
-enable timer:
+Enable timer:
 
 ```bash
 systemctl enable puyoskey.timer
@@ -172,7 +183,7 @@ systemctl enable puyoskey.timer
 
 </details>
 
-## Update 💫
+## Update Guide 💫
 
 ```bash
 git checkout master
@@ -183,31 +194,33 @@ pnpm run build
 pnpm run migrate
 ```
 
-## Something Error 💣
-you should rebuild puyoskey
+## Troubleshooting 💣
+
+If you encounter errors, try rebuilding Puyoskey:
+
 ```bash
 pnpm run clean-all
 pnpm rebuild
 ```
 
-## Update from Sharkey 🦈
+## Updating from Upstream Sharkey 🦈
 
-When Sharkey is updated, puyoskey needs to follow suit!
+When Sharkey is updated, Puyoskey needs to follow suit:
 
 ```bash
-# If u have not yet added sharkey remote
+# If you have not yet added sharkey remote
 git remote add base https://activitypub.software/TransFem-org/Sharkey.git
 
 git fetch base
 git checkout -b stable base/stable
 
-# switch puyoskey branch
+# Switch to puyoskey branch
 git checkout master
-# merge from stable branch
+# Merge from stable branch
 git merge --squash stable
 
-# If u respond to conflicts or u don't got conflicts.
-# Commit message is example.
+# Resolve any conflicts
+# Commit with an appropriate message
 git commit -m ":recycle: Merge updates from upstream as v2024.11.2"
 
 git push origin master
@@ -216,7 +229,7 @@ git push origin master
 ---
 
 <details>
-<summary>Sharkey Original README</summary>
+<summary>Original Sharkey README</summary>
 
 <div align="center">
 <a href="https://joinsharkey.org/">