Skip to content

Commit a1624e6

Browse files
committed
docs: Improve README clarity and completeness
- Add Usage section explaining how to access WebUI (localhost:3000) - Document default password (changeme) and how to change it - Replace JSON config block with clearer settings table - Add descriptions for all configuration options - Rename Development section to Building from Source - Add comments for each platform build command - Remove redundant dev server instructions (already in Running from Source)
1 parent c9fc274 commit a1624e6

1 file changed

Lines changed: 35 additions & 19 deletions

File tree

README.md

Lines changed: 35 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,24 @@ npm start -- --last-used
180180
npm run dev
181181
```
182182

183+
<div align="center">
184+
<h2>Usage</h2>
185+
</div>
186+
187+
After starting the server, open your browser and navigate to:
188+
189+
```
190+
http://localhost:3000
191+
```
192+
193+
Or if accessing from another device on your network:
194+
195+
```
196+
http://<server-ip>:3000
197+
```
198+
199+
**Default Login:** The default password is `changeme`. You should change this in `data/config.json` or via the `--webui-password` flag.
200+
183201
<div align="center">
184202
<h2>Command Line Options</h2>
185203
</div>
@@ -199,34 +217,32 @@ npm run dev
199217

200218
<div align="center">
201219

202-
The application automatically creates a configuration file at `data/config.json` on first run. You can modify this file to customize your experience.
220+
The application automatically creates a configuration file at `data/config.json` on first run.
203221

204222
</div>
205223

206-
```json
207-
{
208-
"WebUIEnabled": true,
209-
"WebUIPort": 3000,
210-
"WebUIPassword": "changeme",
211-
"WebUIPasswordRequired": true,
212-
"SpoolmanEnabled": false,
213-
"SpoolmanServerUrl": "http://your-spoolman-instance:7912",
214-
"CameraProxyPort": 8181
215-
}
216-
```
224+
| Setting | Default | Description |
225+
|---------|---------|-------------|
226+
| `WebUIEnabled` | `true` | Enable/disable the web interface |
227+
| `WebUIPort` | `3000` | Port for the web server |
228+
| `WebUIPassword` | `changeme` | Login password (change this!) |
229+
| `WebUIPasswordRequired` | `true` | Require password to access |
230+
| `SpoolmanEnabled` | `false` | Enable Spoolman integration |
231+
| `SpoolmanServerUrl` | `""` | Your Spoolman server URL (e.g., `http://192.168.1.100:7912`) |
232+
| `CameraProxyPort` | `8181` | Starting port for camera proxies |
217233

218234
<div align="center">
219-
<h2>Development</h2>
235+
<h2>Building from Source</h2>
220236
</div>
221237

222238
```bash
223-
# Start development server with hot-reload
224-
npm run dev
225-
226239
# Build for specific platform
227-
npm run build:linux
228-
npm run build:win
229-
npm run build:mac
240+
npm run build:linux # Linux x64
241+
npm run build:linux-arm # Linux ARM64 (Raspberry Pi 4/5)
242+
npm run build:linux-armv7 # Linux ARMv7 (Raspberry Pi 3)
243+
npm run build:win # Windows x64
244+
npm run build:mac # macOS x64
245+
npm run build:mac-arm # macOS ARM (Apple Silicon)
230246
```
231247

232248
<div align="center">

0 commit comments

Comments
 (0)