diff --git a/rustecal-core/README.md b/rustecal-core/README.md index d1615ab..556c99a 100644 --- a/rustecal-core/README.md +++ b/rustecal-core/README.md @@ -18,7 +18,6 @@ - **Rust** 1.60 or later - **eCAL** C/C++ library v6.0 or later installed and accessible on your system -- **rustecal-sys** v0.1.0 or later ## Installation @@ -26,5 +25,5 @@ Add `rustecal-core` to your `Cargo.toml`: ```toml [dependencies] -rustecal-core = "0.1.0" +rustecal-core = "0.1" ``` diff --git a/rustecal/Cargo.toml b/rustecal/Cargo.toml index 49c6a60..7d5e105 100644 --- a/rustecal/Cargo.toml +++ b/rustecal/Cargo.toml @@ -1,12 +1,20 @@ [package] -name = "rustecal" -version = "0.1.0" -edition = "2021" +name = "rustecal" +version = "0.1.0" +authors = ["Rex Schilasky"] +edition = "2021" +description = "Meta-crate for rustecal: re-exports core, pubsub and service APIs" +license = "Apache-2.0" +repository = "https://github.com/eclipse-ecal/rustecal" +documentation = "https://docs.rs/rustecal" +readme = "README.md" +keywords = ["ecal", "ipc", "pubsub", "rpc", "middleware"] +categories = ["network-programming", "api-bindings"] [dependencies] -rustecal-core = { path = "../rustecal-core" } -rustecal-pubsub = { path = "../rustecal-pubsub", optional = true } -rustecal-service= { path = "../rustecal-service", optional = true } +rustecal-core = "0.1" +rustecal-pubsub = { version = "0.1", optional = true } +rustecal-service = { version = "0.1", optional = true } [features] default = ["pubsub", "service"] diff --git a/rustecal/README.md b/rustecal/README.md new file mode 100644 index 0000000..85c26f6 --- /dev/null +++ b/rustecal/README.md @@ -0,0 +1,39 @@ +# rustecal + +`rustecal` is the meta-crate for the Rust eCAL ecosystem. It re-exports: + +- Core initialization & lifecycle (`rustecal-core`) +- (Typed) Publish/Subscribe API (`rustecal-pubsub`, optional) +- RPC-style Server/Client (`rustecal-service`, optional) + +via Cargo feature flags. + +## Features + +| Feature | Crate | Description | +|-----------|--------------------------------|--------------------------------------| +| `default` | `core`, `pubsub`, `service` | All functionality enabled | +| `pubsub` | `rustecal-pubsub` (optional) | (Typed) Publish/Subscribe API | +| `service` | `rustecal-service` (optional) | RPC-style Server/Client API | + +## Installation + +Add to your `Cargo.toml`: + +```toml +[dependencies] +rustecal = "0.1" +``` + +By default, rustecal enables both pubsub and service. To disable one or both: + +```toml +[dependencies] +rustecal = { version = "0.1", default-features = false, features = ["pubsub"] } +``` + +## See Also + +- [`rustecal-core`](https://docs.rs/rustecal-core) – core init, logging, monitoring +- [`rustecal-pubsub`](https://docs.rs/rustecal-pubsub) – Publish/Subscribe API +- [`rustecal-service`](https://docs.rs/rustecal-service) – RPC-style Service API