summaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index b6ed259..c35c0ea 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,12 @@
+//! Convert repository file lists into Markdown.
+//!
+//! `repo2markdown` reads null-separated path lists, normalizes paths, and renders selected files
+//! into Markdown. It also exposes small utilities for wrapping Markdown in fences and editing
+//! null-separated path lists.
+//!
+//! The crate is used by the main `repo2markdown` binary and by helper binaries such as
+//! `r2md-fence`, `r2md-append`, `r2md-prepend`, and `r2md-remove`.
+
pub mod fence_wrapper;
pub mod fenced_md_generator;
pub mod logger;