docs: 新增 README

880831ian · Jan 5, 2024 · 00fc381 · 00fc381
1 parent 69d70b5
commit 00fc381
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,43 @@
-# racing
+# 巔峰極速 兌換虛寶網頁
+
+## 開發契機
+
+最近很常玩巔峰極速，發現遊戲有虛寶可以兌換，但官方出的虛寶兌換網頁很難用(需要每次都輸入 ID 以及驗證碼，還有虛寶)，所以想說自己寫一個網頁來一鍵兌換虛寶。
+
+## 申明
+
+1. 本專案僅方便大家兌換所有虛寶，並非官方提供，請勿將此工具用於非法用途，否則後果自負。
+
+2. 若需要自行架設兌換網頁，請記得點個星星，<3。
+
+<br>
+
+## 使用說明
+
+1. 請先閱讀網站中的注意事項以及使用說明，使用說明有標示兌換顯示的狀態：
+
+![img](images/1.png)
+
+<br>
+
+2. 輸入遊戲 ID 以及驗證碼，即可自動兌換所有虛寶
+
+![img](images/2.png)
+
+<br>
+
+3. 輸入正確的遊戲 ID 以及驗證碼，下方會顯示兌換虛寶的狀態
+
+![img](images/3.png)
+
+<br>
+
+## 開發環境
+
+1. 可以使用 docker-compose 來建立開發環境
+
+```bash
+docker-compose up -d
+```
+
+2. 開啟網頁 http://localhost:80 即可看到網頁
diff --git a/images/1.png b/images/1.png
diff --git a/images/2.png b/images/2.png
diff --git a/images/3.png b/images/3.png