README: 更新

README.md

@@ -1,51 +1,53 @@
-# LynqChat
+<img src="./assets/lynqchat.svg" width="200" />  
-チャットアプリです。
+
-
+# LynqChatについて
-# サーバー作成
+セルフホスト型チャットアプリです。未完成です。
-
+
-## 本体
+# サーバー作成
-**要件**
+
-- Node.js v24.14以上v25未満
+## 本体
-- pnpm v10.17.0以上
+**要件**
-
+- Node.js v24.14以上v25未満
-```bash
+- pnpm v10.17.0以上
-# configのサンプルをコピー
+
-# config/config.yamlをコメントに従って変更してください。
+```bash
-cp config/example.yaml config/config.yaml
+# configのサンプルをコピー
-
+# config/config.yamlをコメントに従って変更してください。
-# 依存関係のインストール
+cp config/example.yaml config/config.yaml
-pnpm i
+
-
+# 依存関係のインストール
-# ビルド
+pnpm i
-pnpm run build
+
-
+# ビルド
-# データベースのマイグレーション
+pnpm run build
-pnpm -F backend mikro migration:up
+
-
+# データベースのマイグレーション
-# 起動
+pnpm -F backend mikro migration:up
-pnpm -F backend start
+
-```
+# 起動
-
+pnpm -F backend start
-## PostgreSQL
+```
-サーバーがある場合はスキップして構いません。  
+
-空のデータベースが必要です。  
+## PostgreSQL
-現時点で、暗号化通信には対応していません。
+サーバーがある場合はスキップして構いません。  
-
+空のデータベースが必要です。  
-### Nix
+現時点で、暗号化通信には対応していません。
-> **WARNING**
+
-> ローカルのNix Storeにパスワードが平文で保存されます。
+### Nix
-
+> **WARNING**
-WSLの`/mnt/*`では、権限の制約によって動作しません。  
+> ローカルのNix Storeにパスワードが平文で保存されます。
-`/home/*`などのディレクトリで使用してください。
+
-
+WSLの`/mnt/*`では、権限の制約によって動作しません。  
-```bash
+`/home/*`などのディレクトリで使用してください。
-# Configコピー
+
-cp ./config/example.yaml ./config/config.yaml
+```bash
-
+# Configコピー
-# 起動
+cp ./config/example.yaml ./config/config.yaml
-nix develop
+
-
+# 起動
-# 停止:
+nix develop
-pg_ctl -D postgres-data-nix stop
+
-exit
+# 停止:
-```
+pg_ctl -D postgres-data-nix stop
+exit
+```