Skip to content

Commit 0cd36ce

Browse files
committed
feat: update README with a short demo video and improve quick start instructions
1 parent 9c2e956 commit 0cd36ce

File tree

2 files changed

+5
-19
lines changed

2 files changed

+5
-19
lines changed

README.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -71,25 +71,11 @@ Only the `function` node uses the lightweight QuickJS JS interpreter to run Java
7171
- **Container Deployments**: Lightweight containers for edge computing with optional web UI
7272
- **Remote Management**: Access and modify flows remotely through the web interface
7373

74-
## Quick Demo
7574

76-
```bash
77-
# 1. Build EdgeLinkd
78-
cargo build --release
79-
80-
# 2. Start EdgeLinkd with integrated web UI
81-
./target/release/edgelinkd
75+
## A Short Demo
8276

83-
# 3. Open your browser and go to http://127.0.0.1:1888
84-
# 4. Design your flows directly in the browser using the built-in Node-RED editor
85-
# 5. Deploy and run your flows with 90% less memory usage than Node-RED
77+
<video src="assets/short-demo.mp4" controls style="max-width: 100%; height: auto; border: 1px solid #ccc; border-radius: 6px; box-shadow: 0 2px 8px rgba(0,0,0,0.08); margin-bottom: 1em;" title="EdgeLinkd Short Demo"></video>
8678

87-
# Alternative: Run with existing flows.json
88-
./target/release/edgelinkd ~/.node-red/flows.json
89-
90-
# Or run in headless mode for production deployment
91-
./target/release/edgelinkd --headless
92-
```
9379

9480
## Quick Start
9581

@@ -105,7 +91,7 @@ Or if you've already cloned without submodules:
10591

10692
```bash
10793
git clone https://github.com/oldrev/edgelinkd.git
108-
cd edgelink
94+
cd edgelinkd
10995
git submodule update --init --recursive
11096
```
11197

@@ -136,9 +122,9 @@ cargo build --release
136122
**Start EdgeLinkd with integrated web UI (recommended):**
137123

138124
```bash
139-
cargo run -- run
125+
cargo run --release --
140126
# or after build
141-
./target/release/edgelinkd run
127+
./target/release/edgelinkd
142128
```
143129

144130
By default, your browser will open the Node-RED frontend at [http://127.0.0.1:1888](http://127.0.0.1:1888).

assets/short-demo.mp4

2.22 MB
Binary file not shown.

0 commit comments

Comments
 (0)