update
This commit is contained in:
34
README.md
34
README.md
@@ -167,6 +167,23 @@ import msghandlerCSR from './js/msghandler.js';
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Prerequisites
|
||||
|
||||
1. **Transport Channel** - Choose your communication channel:
|
||||
- **NATS** (recommended): `docker run -p 4222:4222 nats:latest`
|
||||
- **HTTP/WebSocket**: Any HTTP server or WebSocket endpoint
|
||||
- **Custom**: Implement your own transport mechanism
|
||||
|
||||
2. **HTTP File Server** (optional, for payloads ≥ 500KB) - Install and run:
|
||||
```bash
|
||||
# Using Plik
|
||||
docker run -p 8080:8080 -v /tmp/fileserver:/var/lib/plik -e PLIK_ADMIN_PASSWORD=admin plik/plik
|
||||
|
||||
# OR using Python HTTP server
|
||||
mkdir -p /tmp/fileserver
|
||||
python3 -m http.server 8080 --directory /tmp/fileserver
|
||||
```
|
||||
|
||||
### Julia Backend
|
||||
|
||||
#### Installation
|
||||
@@ -311,23 +328,6 @@ for (const [dataname, data, type] of envelope.payloads) {
|
||||
console.log(`${dataname}:`, data, `(type: ${type})`);
|
||||
}
|
||||
```
|
||||
|
||||
### Prerequisites
|
||||
|
||||
1. **Transport Channel** - Choose your communication channel:
|
||||
- **NATS** (recommended): `docker run -p 4222:4222 nats:latest`
|
||||
- **HTTP/WebSocket**: Any HTTP server or WebSocket endpoint
|
||||
- **Custom**: Implement your own transport mechanism
|
||||
|
||||
2. **HTTP File Server** (optional, for payloads ≥ 500KB) - Install and run:
|
||||
```bash
|
||||
# Using Plik
|
||||
docker run -p 8080:8080 -v /tmp/fileserver:/var/lib/plik -e PLIK_ADMIN_PASSWORD=admin plik/plik
|
||||
|
||||
# OR using Python HTTP server
|
||||
mkdir -p /tmp/fileserver
|
||||
python3 -m http.server 8080 --directory /tmp/fileserver
|
||||
```
|
||||
---
|
||||
|
||||
## API Reference
|
||||
|
||||
Reference in New Issue
Block a user