dexbot 1.4.14 → 1.4.15

package/README.md

@@ -40,13 +40,6 @@ git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install &&
 dexbot key                 # Set up master password and import keys
 dexbot bot                 # Create and manage bot configurations
 dexbot start               # Start DEXBot2
-
-# Option C — Clone + local (no global install, works on all platforms)
-git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install
-
-npx dexbot key                 # Set up master password and import keys
-npx dexbot bot                 # Create and manage bot configurations
-npx dexbot start               # Start DEXBot2
 ```
 
 Detailed setup: [Installation](#-installation).
@@ -65,12 +58,10 @@ New to BitShares? Work through the [BitShares Onboarding Tutorial](docs/BITSHARE
 
 ### Prerequisites
 
-You'll need **Git** and **Node.js** installed.
+You'll need **Git** and **Node.js** v22.12 or newer installed.
 
 #### Linux Users
 
-DEXBot needs Node.js v22.12 or newer. Most distro repos ship an outdated `nodejs` package, so install Node from [nodejs.org](https://nodejs.org/en/download).
-
 Install Git:
 
 ```bash
@@ -82,7 +73,7 @@ sudo apt-get install git
 sudo dnf install git
 ```
 
-Then install Node.js via nvm:
+Most distro repos ship an outdated `nodejs` package, so install Node from [nodejs.org](https://nodejs.org/en/download).
 
 ```bash
 # e.g. via nvm (from https://nodejs.org/en/download)
@@ -99,8 +90,6 @@ node --version && npm --version && git --version
 
 #### macOS Users
 
-DEXBot needs Node.js v22.12 or newer.
-
 Use Homebrew to install Node.js and Git:
 ```bash
 # Install Homebrew if not already installed
@@ -112,8 +101,6 @@ brew install node git
 
 #### Windows Users
 
-DEXBot needs Node.js v22.12 or newer.
-
 1. Install **Git** from [git-scm.com](https://git-scm.com/install/windows) (accept defaults, restart after)
 2. Install **Node.js LTS** from [nodejs.org](https://nodejs.org/en/download) (accept defaults, restart after)
 3. Verify installation in Command Prompt:
@@ -130,49 +117,44 @@ npm i -g dexbot
 
 # Option B — Clone + npm link
 git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install && npm link
-
-# Option C — Clone + local (no global install, works on all platforms)
-git clone https://github.com/froooze/DEXBot2.git && cd DEXBot2 && npm install
-npx dexbot
-npx dexbot start
 ```
 
-Then set up your master password, keys and add bots:
+## 🔧 Configuration
 
-```bash
-dexbot key
-dexbot bot
-```
+### Create Your Bot
 
-## 🔧 Configuration
+1. Set up your master password and import your BitShares **active** key (WIF):
 
-### Recommended Bot Setup
+   ```bash
+   dexbot key
+   ```
 
-Keep the generated defaults and tune only these first:
+2. Create a bot through the interactive prompts:
 
-1. `targetSpreadPercent`
-2. `incrementPercent`
-3. `gridPrice: "ama"`
-4. `minPrice` / `maxPrice`
+   ```bash
+   dexbot bot
+   ```
 
-`targetSpreadPercent` controls profit room per completed cycle. A wider spread
-targets more profit per cycle but trades less often.
+   This stores your configuration in `profiles/bots.json`. The generated
+   defaults are a good starting point — the next step walks through the few
+   options worth tuning.
 
-`incrementPercent` controls grid density and order size. Smaller increments
-create more grid levels and smaller orders; larger increments create fewer
-levels and larger orders.
+### Recommended Bot Setup
+
+Keep the default settings first, and tune these:
 
-Use `gridPrice: "ama"` so the market adapter can center the grid on AMA. Once
-AMA is active, tighten `minPrice` / `maxPrice` around the maximum expected
-market volatility instead of using an unnecessarily wide range.
+1. **Tune `targetSpreadPercent`** — controls profit room per completed cycle. A
+   wider spread targets more profit per cycle but trades less often.
 
-### Simple AMA Workflow
+2. **Tune `incrementPercent`** — controls grid density and order size. Smaller
+   increments create more grid levels and smaller orders; larger increments
+   create fewer levels and larger orders.
 
-1. Create the bot with `dexbot bot`.
-2. Leave defaults unchanged.
-3. Tune `targetSpreadPercent` and `incrementPercent`.
-4. Set `gridPrice` to `ama`.
-5. Generate the market-adapter whitelist:
+3. **Set `gridPrice` to `"ama"`** — so the market adapter can center the grid
+   on AMA. Pick a specific preset if desired: `"ama1"` is the fastest,
+   `"ama4"` the slowest, and `"ama"` uses the pair's default preset.
+
+4. **Generate the market-adapter whitelist:**
 
    ```bash
    dexbot white
@@ -182,8 +164,11 @@ market volatility instead of using an unnecessarily wide range.
    live writes and range scaling. Use `dexbot white --dynamic-weight` for
    newly generated dynamic-weight entries; existing entries are preserved.
 
-6. Start DEXBot2 with `dexbot start` (or `dexbot pm2` for PM2).
-7. Then tune `minPrice` / `maxPrice` for the market's volatility range.
+5. **Start DEXBot2** with `dexbot start`.
+
+6. **Tune `minPrice` / `maxPrice`** around the market's volatility range. Once
+   AMA is active, tighten them around the maximum expected market volatility
+   instead of using an unnecessarily wide range.
 
 ### Bot Options Reference