📚 update readme (README.md)

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 -
@@ -35,23 +46,24 @@ corepack enable
 # To type y
 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 +72,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 +94,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 +139,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 +176,7 @@ ExecStart=/usr/bin/systemctl restart puyoskey.service
 WantedBy=multi-user.target
 ```
 
-enable timer:
+Enable timer:
 
 ```bash
 systemctl enable puyoskey.timer
@@ -172,7 +184,7 @@ systemctl enable puyoskey.timer
 
 </details>
 
-## Update 💫
+## Update Guide 💫
 
 ```bash
 git checkout master
@@ -183,31 +195,33 @@ pnpm run build
 pnpm run migrate
 ```
 
-## Something Error 💣
+## Troubleshooting 💣
-you should rebuild puyoskey
+
+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.
+# Resolve any conflicts
-# Commit message is example.
+# Commit with an appropriate message
 git commit -m ":recycle: Merge updates from upstream as v2024.11.2"
 
 git push origin master
@@ -216,7 +230,7 @@ git push origin master
 ---
 
 <details>
-<summary>Sharkey Original README</summary>
+<summary>Original Sharkey README</summary>
 
 <div align="center">
 <a href="https://joinsharkey.org/">
@@ -248,20 +262,21 @@ git push origin master
 <a href="https://joinsharkey.org/"><img src="https://cdn.shonk.social/files/b671c81c-58cf-4f13-bc96-af0b0c96c667.webp" align="right" height="520px"/></a>
 
 ## ✨ Features
+
 - **ActivityPub support**\
-Not on Sharkey? No problem! Not only can Sharkey instances talk to each other, but you can make friends with people on other networks like Mastodon and Pixelfed!
+  Not on Sharkey? No problem! Not only can Sharkey instances talk to each other, but you can make friends with people on other networks like Mastodon and Pixelfed!
 - **Federated Backgrounds and Music status**\
-You can add a background to your profile as well as a music status via ListenBrainz, show everyone what music you are currently listening to
+  You can add a background to your profile as well as a music status via ListenBrainz, show everyone what music you are currently listening to
 - **Mastodon API**\
-Sharkey implements the Mastodon API unlike normal Misskey
+  Sharkey implements the Mastodon API unlike normal Misskey
 - **UI/UX Improvements**\
-Sharkey makes some UI/UX improvements to make it easier to navigate
+  Sharkey makes some UI/UX improvements to make it easier to navigate
 - **Sign-Up Approval**\
-With Sharkey, you can enable sign-ups, subject to manual moderator approval and mandatory user-provided reasons for joining.
+  With Sharkey, you can enable sign-ups, subject to manual moderator approval and mandatory user-provided reasons for joining.
 - **Rich Web UI**\
-       Sharkey has a rich and easy to use Web UI!
+   Sharkey has a rich and easy to use Web UI!
-       It is highly customizable, from changing the layout and adding widgets to making custom themes.
+  It is highly customizable, from changing the layout and adding widgets to making custom themes.
-       Furthermore, plugins can be created using AiScript, an original programming language.
+  Furthermore, plugins can be created using AiScript, an original programming language.
 - And much more...
 
 </div>
@@ -272,4 +287,5 @@ With Sharkey, you can enable sign-ups, subject to manual moderator approval and
 
 Sharkey Documentation can be found at [Sharkey Documentation](https://docs.joinsharkey.org/docs/install/fresh/)
 
-</details>
+</details>
+