diff --git a/README.md b/README.md
index c109620825..5069009b52 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,29 @@

-
ぷよすきー
+
ぷよすきー (Puyoskey)
-**🌎 [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/)**
-## 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 💨
- Install depencies for AlmaLinux 9 Server ⛏️
+ Install dependencies for AlmaLinux 9 Server ⛏️
-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
```
-- 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
```
-Run with systemd (you should change user as root)
+Run with systemd (you should change user to root)
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
-## 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
---
-Sharkey Original README
+Original Sharkey README