Skip to content

Commit 4899656

Browse files
committed
README.md fix
1 parent 9e7c148 commit 4899656

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# rustecal
22

3-
[![Docs](https://img.shields.io/badge/docs-mdbook-blue)](https://rex-schilasky.github.io/rustecal/)
4-
5-
Safe and idiomatic Rust bindings for the [eCAL](https://github.com/eclipse-ecal/ecal) middleware — a high-performance IPC framework designed for distributed real-time systems.
3+
Rust bindings for the high-performance [eCAL](https://github.com/eclipse-ecal/ecal) middleware, providing efficient pub/sub and service-based communication for interprocess and distributed systems.
64

75
---
86

@@ -113,12 +111,21 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
113111

114112
## Documentation
115113

116-
- 📘 API Docs: [docs.rs/rustecal](https://docs.rs/rustecal)
117-
- 📖 Guide & Examples: see `docs/` (mdBook)
114+
📚 Full user guide: [https://rex-schilasky.github.io/rustecal](https://rex-schilasky.github.io/rustecal)
115+
116+
```bash
117+
cd docs/
118+
mdbook serve
119+
```
118120

119121
---
120122

121123
## License
122124

123-
Licensed under the Apache License 2.0 (see [LICENSE](./LICENSE))
124-
© 2024–2025 Eclipse Contributors / Rex Schilasky
125+
Licensed under Apache-2.0 or MIT.
126+
127+
---
128+
129+
## Maintainer
130+
131+
[Rex Schilasky](https://github.com/rex-schilasky)

0 commit comments

Comments
 (0)