ask-bridge 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.en.md +23 -4
  2. package/README.md +23 -6
  3. package/package.json +1 -1
package/README.en.md CHANGED
@@ -39,17 +39,36 @@ You do **not** need a global `mcp-cli` executable. The Rust binary uses `mcp-cli
39
39
 
40
40
  ## 🚀 Installation & Build
41
41
 
42
- ### 1. Build the Rust Project
42
+ ### 1. Quick Installation (Recommended)
43
43
 
44
- Clone or navigate to the project directory and install with Make:
44
+ If you only want to use the pre-compiled Release version (without installing the Rust toolchain), you can run one of the following one-liner installation scripts. They will automatically verify the Node.js requirement, download the appropriate binary for your system architecture, and place it in your `~/.local/bin/` folder.
45
+
46
+ #### macOS / Linux
47
+ Open your terminal and run:
48
+ ```bash
49
+ curl -fsSL https://raw.githubusercontent.com/doggy8088/ask-bridge/main/install.sh | bash
50
+ ```
51
+
52
+ #### Windows
53
+ Open PowerShell (recommended to Run as Administrator) and run:
54
+ ```powershell
55
+ irm https://raw.githubusercontent.com/doggy8088/ask-bridge/main/install.ps1 | iex
56
+ ```
57
+
58
+ > [!NOTE]
59
+ > Make sure the installation path (`~/.local/bin` for macOS/Linux, and `$HOME\.local\bin` for Windows) is added to your system's `PATH` environment variable.
60
+
61
+ ### 2. Build & Install from Source (For Developers)
62
+
63
+ Clone or navigate to the project directory and build/install with Make:
45
64
 
46
65
  ```bash
47
66
  make install
48
67
  ```
49
68
 
50
- This installs the required Chrome browser when needed, builds the optimized binary, and links it to `~/.local/bin/ask`.
69
+ This verifies the Node.js environment, installs the required Chrome browser if needed, builds the optimized binary, and links it to `~/.local/bin/ask`.
51
70
 
52
- ### 2. Add to PATH
71
+ ### 3. Build Only
53
72
 
54
73
  If you only want to build without installing:
55
74
 
package/README.md CHANGED
@@ -34,19 +34,36 @@
34
34
 
35
35
  ## 安裝與建置
36
36
 
37
- ### 1. 安裝工具
37
+ ### 1. 快速安裝 (推薦)
38
38
 
39
- 在專案目錄執行:
39
+ 若您只想使用已編譯好的 Release 版本(不需要安裝 Rust 工具鏈),可直接使用以下一鍵安裝腳本。安裝腳本會自動檢查 Node.js 需求、下載適合您系統架構的 ask-bridge binary,並將其放入 `~/.local/bin/` 目錄中。
40
40
 
41
+ #### macOS / Linux
42
+ 請開啟終端機執行:
41
43
  ```bash
42
- make install
44
+ curl -fsSL https://raw.githubusercontent.com/doggy8088/ask-bridge/main/install.sh | bash
45
+ ```
46
+
47
+ #### Windows
48
+ 請開啟 PowerShell (建議以系統管理員身分) 執行:
49
+ ```powershell
50
+ irm https://raw.githubusercontent.com/doggy8088/ask-bridge/main/install.ps1 | iex
43
51
  ```
44
52
 
45
- 此命令會安裝必要的 Chrome 瀏覽器、建置最佳化 binary,並建立 `~/.local/bin/ask` symlink。
53
+ > [!NOTE]
54
+ > 請確保安裝路徑(macOS/Linux 為 `~/.local/bin`;Windows 為 `$HOME\.local\bin`)已加入您的系統 `PATH` 環境變數中。
55
+
56
+ ### 2. 從原始碼建置與安裝 (適用於開發者)
57
+
58
+ 若您想從原始碼編譯並安裝,請在複製本專案後,在專案目錄下執行:
59
+
60
+ ```bash
61
+ make install
62
+ ```
46
63
 
47
- 請確認 `~/.local/bin` 已加入 shell 的 `PATH`。
64
+ 此命令會自動檢查 Node.js 環境、檢查與安裝 Chrome 瀏覽器、建置最佳化的 binary,並在 `~/.local/bin/ask` 建立符號連結 (symlink)。
48
65
 
49
- ### 2. 只建置不安裝
66
+ ### 3. 只建置不安裝
50
67
 
51
68
  若只想建置 binary:
52
69
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ask-bridge",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Automate ChatGPT or Gemini from the command line through Chrome.",
5
5
  "bin": {
6
6
  "ask": "npm/cli.cjs"