Skip to content

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

feat: added documentation pointing people toward the Obsidian plugin

Elijah Potter4e5167cae78a
diff --git a/README.md b/README.md
index 827006406..fb7556d96 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,17 @@ Harper is even small enough to load via [WebAssembly.](https://writewithharper.c
## Installation
-If you want to use Harper on your machine, you will want to look at the [documentation for `harper-ls`](./harper-ls/README.md), the Language Server Protocol implementation.
+If you want to use Harper on your machine, you have two choices.
+
+### `harper-ls`
+
+`harper-ls` provides an integration that works for most code editors.
+
+[Read more here.](./harper-ls/README.md)
+
+### Harper Obsidian Integration
+
+If you use [Obsidian](https://obsidian.md/), you may install the [Harper Obsidian Plugin](https://github.com/elijah-potter/harper-obsidian-plugin) by searching for "Harper" in the community plugin store.
## Performance Issues
diff --git a/packages/obsidian-plugin/README.md b/packages/obsidian-plugin/README.md
index aa8ba7465..a7e95116f 100644
--- a/packages/obsidian-plugin/README.md
+++ b/packages/obsidian-plugin/README.md
@@ -2,6 +2,8 @@
This directory contains the source code for the [Obsidian](https://obsidian.md/) plugin.
+The full documentation can be found [here](https://github.com/elijah-potter/harper-obsidian-plugin).
+
## Building
In order to build the plugin, you may use `just` like so: