From b18cfbae238d53de193fc7671f56ec779574094c Mon Sep 17 00:00:00 2001
From: Ivan Molodetskikh <yalterz@gmail.com>
Date: Sat, 9 Nov 2024 17:46:23 +0300
Subject: [PATCH] niri-ipc: Add README and Cargo.toml metadata

---
 niri-ipc/Cargo.toml |  6 +++++-
 niri-ipc/README.md  | 16 ++++++++++++++++
 niri-ipc/src/lib.rs |  7 +++++++
 3 files changed, 28 insertions(+), 1 deletion(-)
 create mode 100644 niri-ipc/README.md

diff --git a/niri-ipc/Cargo.toml b/niri-ipc/Cargo.toml
index 1861799a7..a860c0025 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 000000000..7bf3642da
--- /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 697596264..f2eccdcb6 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;