Include README in generated rustdoc files.

github · Jan 28, 2024 · 0b8aede · 0b8aede
1 parent bf91a2b
commit 0b8aede
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/crates/twirp-build/README.md b/crates/twirp-build/README.md
@@ -0,0 +1,5 @@
+# twirp-build
+
+The `twirp-build` package is responsible for generating Twirp RPC service definitions from `.proto` files.
+
+For more information, consult the documentation for the main `twirp` package.
diff --git a/crates/twirp-build/src/lib.rs b/crates/twirp-build/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 use std::fmt::Write;
 
 /// Generates twirp services for protobuf rpc service definitions.

diff --git a/crates/twirp/src/lib.rs b/crates/twirp/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../../../README.md")]
+
 #[cfg(feature = "client")]
 pub mod client;