miravo 0.6.1 → 0.6.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +38 -5
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -1,13 +1,46 @@
1
- # miravo — Node launcher for the Miravo industrial environment platform
1
+ <p align="center">
2
+ <img src="https://miravo.dev/miravo-logo.webp" alt="Miravo" width="120" />
3
+ </p>
2
4
 
3
- Install:
5
+ <p align="center">Industrial environments as code.</p>
4
6
 
5
- ```sh
7
+ <p align="center"><strong>Miravo</strong> is an open-source industrial modeling and simulation platform. Describe the plant once. Miravo runs it with real topology, lifecycle wear, and cascading faults — and speaks MQTT, OPC UA, and Modbus TCP at the same time, the way a real plant does.</p>
8
+
9
+ <p align="center">
10
+ <img src="https://miravo.dev/console-screenshot.png" alt="Miravo Console" width="80%" />
11
+ </p>
12
+
13
+ ---
14
+
15
+ ## Quickstart
16
+
17
+ Install Miravo on Linux/macOS.
18
+
19
+ ```shell
20
+ curl -fsSL https://miravo.dev/install | bash
21
+ ```
22
+
23
+ ```shell
6
24
  npm install -g miravo
7
25
  ```
8
26
 
9
27
  Use Node.js >= 18.
10
28
 
11
- This package runs the platform-specific Miravo binary.
29
+ [Full install options: Docker, Windows guidance, and standalone binaries.](https://miravo.dev/docs#1-install-miravo)
30
+
31
+ Get started with the [`Smart Factory`](https://miravo.dev/docs/environments/smart-factory) environment — the Console opens at `http://127.0.0.1:8080`.
32
+
33
+ ```shell
34
+ miravo start
35
+ ```
36
+
37
+ ## Docs
38
+
39
+ - [**Documentation**](https://miravo.dev/docs)
40
+ - [**Core concepts**](https://miravo.dev/docs/core/concepts)
41
+ - [**Twin models**](https://miravo.dev/docs/core/twin-models)
42
+ - [**CLI reference**](https://miravo.dev/docs/cli/reference)
43
+ - [**Protocols**](https://miravo.dev/docs/protocols) — MQTT, OPC UA, Modbus TCP
44
+ - [**Platforms**](https://miravo.dev/docs/platforms) — Litmus Edge today; Ignition, AWS IoT, Azure IoT in the works
12
45
 
13
- Full docs: https://miravo.dev/docs
46
+ This repository is licensed under the [Apache-2.0 License](LICENSE).
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "miravo",
3
- "version": "0.6.1",
3
+ "version": "0.6.3",
4
4
  "description": "Industrial environment platform — Node launcher that runs the platform-specific Miravo binary.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
7
7
  "type": "git",
8
- "url": "https://github.com/amine-amaach/miravo.git",
8
+ "url": "git+https://github.com/amine-amaach/miravo.git",
9
9
  "directory": "packages/cli-launcher"
10
10
  },
11
11
  "bin": {
@@ -20,11 +20,11 @@
20
20
  "node": ">=18"
21
21
  },
22
22
  "optionalDependencies": {
23
- "@miravo/cli-linux-x64": "0.6.1",
24
- "@miravo/cli-linux-arm64": "0.6.1",
25
- "@miravo/cli-darwin-x64": "0.6.1",
26
- "@miravo/cli-darwin-arm64": "0.6.1",
27
- "@miravo/cli-windows-x64": "0.6.1"
23
+ "@miravo/cli-linux-x64": "0.6.3",
24
+ "@miravo/cli-linux-arm64": "0.6.3",
25
+ "@miravo/cli-darwin-x64": "0.6.3",
26
+ "@miravo/cli-darwin-arm64": "0.6.3",
27
+ "@miravo/cli-windows-x64": "0.6.3"
28
28
  },
29
29
  "exports": {
30
30
  "./package.json": "./package.json"