niri-ipc: Add README and Cargo.toml metadata

2026-06-22 02:01:55 +07:00 · 2024-11-09 17:46:23 +03:00
parent f64e7e14c3
commit b18cfbae23
3 changed files with 28 additions and 1 deletions
@@ -0,0 +1,16 @@
+# niri-ipc
+
+Types and helpers for interfacing with the [niri](https://github.com/YaLTeR/niri) Wayland compositor.
+
+## Backwards compatibility
+
+This crate follows the niri version.
+It is **not** API-stable in terms of the Rust semver.
+In particular, expect new struct fields and enum variants to be added in patch version bumps.
+
+Use an exact version requirement to avoid breaking changes:
+
+```toml
+[dependencies]
+niri-ipc = "=0.1.10"
+```