niri-ipc: Add README and Cargo.toml metadata

3 files changed, 28 insertions, 1 deletions

diff --git a/niri-ipc/Cargo.toml b/niri-ipc/Cargo.toml
index 1861799a..a860c002 100644
--- a/niri-ipc/Cargo.toml
+++ b/niri-ipc/Cargo.toml
@@ -1,12 +1,16 @@
 [package]
 name = "niri-ipc"
 version.workspace = true
-description.workspace = true
 authors.workspace = true
 license.workspace = true
 edition.workspace = true
 repository.workspace = true
 
+description = "Types and helpers for interfacing with the niri Wayland compositor."
+keywords = ["wayland"]
+categories = ["api-bindings", "os"]
+readme = "README.md"
+
 [dependencies]
 clap = { workspace = true, optional = true }
 schemars = { version = "0.8.21", optional = true }
diff --git a/niri-ipc/README.md b/niri-ipc/README.md
new file mode 100644
index 00000000..7bf3642d
--- /dev/null
+++ b/niri-ipc/README.md
@@ -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"
+```
diff --git a/niri-ipc/src/lib.rs b/niri-ipc/src/lib.rs
index 69759626..f2eccdcb 100644
--- a/niri-ipc/src/lib.rs
+++ b/niri-ipc/src/lib.rs
@@ -19,6 +19,13 @@
 //!
 //! 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"
+//! ```
 #![warn(missing_docs)]
 
 use std::collections::HashMap;