Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat: made README's appear in docs

Elijah Potterc5d7debb0e4b
diff --git a/harper-cli/src/main.rs b/harper-cli/src/main.rs
index 5cbddd915..85be6b75c 100644
--- a/harper-cli/src/main.rs
+++ b/harper-cli/src/main.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
use std::path::{Path, PathBuf};
use anyhow::format_err;
diff --git a/harper-comments/src/lib.rs b/harper-comments/src/lib.rs
index 976bd9900..ed3eebd4b 100644
--- a/harper-comments/src/lib.rs
+++ b/harper-comments/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
mod comment_parsers;
mod tree_sitter_parser;
diff --git a/harper-core/src/lib.rs b/harper-core/src/lib.rs
index baac1f84d..e646e8d73 100644
--- a/harper-core/src/lib.rs
+++ b/harper-core/src/lib.rs
@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
#![allow(dead_code)]
mod char_ext;
diff --git a/harper-ls/src/main.rs b/harper-ls/src/main.rs
index fba15062f..d54da6413 100644
--- a/harper-ls/src/main.rs
+++ b/harper-ls/src/main.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
use std::io::stderr;
use config::Config;