diff --git a/README.md b/README.md index faa760b2..4be95f22 100644 --- a/README.md +++ b/README.md @@ -172,13 +172,13 @@ cargo install dora-cli ### With Github release for macOS and Linux ```bash -curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/dora-rs/dora/main/install.sh | bash +curl --proto '=https' --tlsv1.2 -LsSf https://github.com/dora-rs/dora/releases/latest/download/dora-cli-installer.sh | sh ``` ### With Github release for Windows ```powershell -powershell -c "irm https://raw.githubusercontent.com/dora-rs/dora/main/install.ps1 | iex" +powershell -ExecutionPolicy ByPass -c "irm https://github.com/dora-rs/dorareleases/latest/download/dora-cli-installer.ps1 | iex" ``` ### With Source @@ -311,7 +311,6 @@ turtle_twist_writer.publish(message) > You might want to use ChatGPT to write the Arrow Formatting: https://chat.openai.com/share/4eec1c6d-dbd2-46dc-b6cd-310d2895ba15 - ## Zenoh Integration for Distributed Dataflow (Experimental) Zenoh is a high-performance pub/sub and query protocol that unifies data in motion and at rest. In **dora-rs**, Zenoh is used for remote communication between nodes running on different machines, enabling distributed dataflow across networks. @@ -320,7 +319,7 @@ Zenoh is a high-performance pub/sub and query protocol that unifies data in moti - **Definition:** [Zenoh](https://zenoh.io) is an open-source communication middleware offering pub/sub and query capabilities. -- **Benefits in DORA:** +- **Benefits in DORA:** - Simplifies communication between distributed nodes. - Handles NAT traversal and inter-network communication. - Integrates with DORA to manage remote data exchange while local communication still uses efficient shared memory. @@ -332,20 +331,21 @@ Zenoh is a high-performance pub/sub and query protocol that unifies data in moti ```bash docker run -p 7447:7447 -p 8000:8000 --name zenoh-router eclipse/zenohd:latest + ``` - -```markdown +````markdown ## Create a Zenoh Configuration File 🎛️ Create a file (e.g., `zenoh.json5`) with the router endpoint details: ```json5 { - "connect": { - "endpoints": [ "tcp/203.0.113.10:7447" ] - } + connect: { + endpoints: ["tcp/203.0.113.10:7447"], + }, } ``` +```` --- @@ -354,7 +354,7 @@ Create a file (e.g., `zenoh.json5`) with the router endpoint details: On each machine, export the configuration and start the daemon: ```bash -export ZENOH_CONFIG=/path/to/zenoh.json5 +export ZENOH_CONFIG=/path/to/zenoh.json5 dora daemon --coordinator-addr --machine-id ``` @@ -390,6 +390,7 @@ dora start dataflow.yml ``` --- + ## YAML Example for Distributed Dataflow 📘 ```yaml @@ -411,8 +412,8 @@ nodes: image: camera_node/image outputs: - result - ``` + ## Contributing We are passionate about supporting contributors of all levels of experience and would love to see @@ -441,4 +442,7 @@ This project is licensed under Apache-2.0. Check out [NOTICE.md](NOTICE.md) for - [Zenoh Documentation](https://zenoh.io/docs/) - [DORA Zenoh Discussion (GitHub Issue #512)](https://github.com/dora-rs/dora/issues/512) - [Dora Autoware Localization Demo](https://github.com/dora-rs/dora-autoware-localization-demo) + +``` + ```