appium-session-recorder 0.0.1 → 0.0.3

package/README.md

@@ -22,7 +22,7 @@ A modern Appium recorder and automation CLI with real-time UI visualization, ses
 
 ### Prerequisites
 
-- [Bun](https://bun.sh/) runtime installed
+- [Node.js](https://nodejs.org/) >= 18 or [Bun](https://bun.sh/) runtime
 - [Appium](https://appium.io/) server installed
 
 ### Start Appium Server
@@ -38,14 +38,13 @@ The recorder proxy itself does not require `--allow-cors` for normal usage.
 ### Installation
 
 ```bash
-cd appium-session-recorder # (or your cloned folder name)
-bun install
+npm i -g appium-session-recorder
 ```
 
 ### Run the CLI
 
 ```bash
-bun run cli
+appium-recorder
 ```
 
 The CLI will interactively prompt you for:
@@ -56,13 +55,13 @@ The CLI will interactively prompt you for:
 Alternatively, use command-line arguments:
 
 ```bash
-bun run cli --port 8080 --appium-url http://192.168.1.100:4723
+appium-recorder --port 8080 --appium-url http://192.168.1.100:4723
 ```
 
 Or run command mode (JSON output by default):
 
 ```bash
-bun run cli session create --appium-url http://127.0.0.1:4723 --caps-file ./caps.json --pretty
+appium-recorder session create --appium-url http://127.0.0.1:4723 --caps-file ./caps.json --pretty
 ```
 
 ### Configure Appium Inspector
@@ -102,7 +101,7 @@ This project is intended for **local testing and development**. It runs an unaut
 ### Command Mode (JSON)
 
 ```bash
-bun run cli <group> <command> [flags]
+appium-recorder <group> <command> [flags]
 ```
 
 Available command groups:
@@ -117,7 +116,7 @@ Global command flags:
 
 - `--pretty` pretty-print JSON
 - `--output <path>` persist JSON output to a file
-- Legacy mode (`bun run cli [legacy-options]`) does not accept `--pretty` or `--output`
+- Legacy mode (`appium-recorder [legacy-options]`) does not accept `--pretty` or `--output`
 
 ### Agent Skill
 
@@ -139,17 +138,12 @@ appium --port 4723 --allow-cors
 
 2. (Optional) Install skill globally for Codex:
 
-```bash
-mkdir -p ~/.codex/skills
-cp -R ./skills/appium-cli-selector-navigator ~/.codex/skills/appium-cli-selector-navigator
-```
-
 ```bash
 mkdir -p ~/.claude/skills
 cp -R ./skills/appium-cli-selector-navigator ~/.claude/skills/appium-cli-selector-navigator
 ```
 
-Restart Codex after installing the global skill.
+Restart Claude after installing the global skill.
 
 3. Create a capabilities file (example iOS Safari):
 
@@ -242,7 +236,7 @@ appium-recorder session delete \
 ### Legacy CLI Options (Backwards Compatible)
 
 ```bash
-bun run cli [options]
+appium-recorder [options]
 
 OPTIONS:
   -p, --port <number>        Proxy server port (default: 4724)
@@ -265,7 +259,7 @@ APPIUM_URL=http://192.168.1.100:4723
 PROXY_PORT=8080
 PROXY_HOST=127.0.0.1
 
-bun run cli
+appium-recorder
 ```
 
 ## 🎨 UI Features
@@ -297,6 +291,22 @@ bun run cli
 
 ## 🔧 Development
 
+### Setup
+
+```bash
+git clone https://github.com/JustasMonkev/appium-session-recorder.git
+cd appium-session-recorder
+bun install
+```
+
+### Run from Source
+
+```bash
+bun run cli
+```
+
+This is equivalent to `appium-recorder` but runs directly from source. All examples in this README that use `appium-recorder` can be replaced with `bun run cli` during development.
+
 ### Build the UI
 
 ```bash
@@ -315,6 +325,14 @@ bun run dev
 bun run cli
 ```
 
+### Run Tests
+
+```bash
+bun run test           # Run all tests
+bun run test:watch     # Watch mode
+bun run test:coverage  # With coverage
+```
+
 ### Build for Production
 
 ```bash