Skip to content

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

docs: beefed out `README.md`

Elijah Potter780aec9405df
diff --git a/README.md b/README.md
index b1afce65e..f9b773406 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
-# Harper for WordPress
+# Harper for WordPress
-This repository will contain the Harper plugin for WordPress.
+![The early prototype version of the plugin](./screenshot.png)
+
+This repository contains the WordPress plugin for [Harper](https://writewithharper.com).
+As it is a work-in-progress, we are keeping the source code private.
+
+## Compiling from Source
+
+The Harper plugin uses the standard build tooling available for WordPress plugins.
+
+```bash
+yarn install # Install dependencies
+yarn format # Format the code
+yarn build # Build the plugin
+yarn plugin-zip # Package the plugin into an installable ZIP file
+```
diff --git a/screenshot.png b/screenshot.png
new file mode 100644
index 000000000..a7e5c58de
Binary files /dev/null and b/screenshot.png differ