Include readme as docs for all crates

maplibre · Oct 31, 2023 · 23ff5b4 · 23ff5b4
1 parent 09dd2be
commit 23ff5b4
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/martin-tile-utils/src/lib.rs b/martin-tile-utils/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 // This code was partially adapted from https://github.com/maplibre/mbtileserver-rs
 // project originally written by Kaveh Karimi and licensed under MIT/Apache-2.0
 

diff --git a/martin/src/lib.rs b/martin/src/lib.rs
@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![forbid(unsafe_code)]
 #![warn(clippy::pedantic)]
 // Bounds struct derives PartialEq, but not Eq,

diff --git a/mbtiles/src/lib.rs b/mbtiles/src/lib.rs
@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![allow(clippy::missing_errors_doc)]
 
 mod errors;