Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat(vscode-plugin): add docs
Matthew Espinoc58d9209c23d
diff --git a/packages/vscode-plugin/.vscodeignore b/packages/vscode-plugin/.vscodeignoreindex d315a5fb3..f481d31a9 100644--- a/packages/vscode-plugin/.vscodeignore+++ b/packages/vscode-plugin/.vscodeignore@@ -2,3 +2,4 @@!build!package.json!LICENSE+!CHANGELOG.mddiff --git a/packages/vscode-plugin/CHANGELOG.md b/packages/vscode-plugin/CHANGELOG.mdnew file mode 100644index 000000000..69649e6ec--- /dev/null+++ b/packages/vscode-plugin/CHANGELOG.md@@ -0,0 +1,5 @@+# Changelog++## 0.0.1++- Initial releasediff --git a/packages/vscode-plugin/README.md b/packages/vscode-plugin/README.mdnew file mode 100644index 000000000..65a5598eb--- /dev/null+++ b/packages/vscode-plugin/README.md@@ -0,0 +1,37 @@+# Harper for VS Code++Currently, `harper-ls` needs to be in your `PATH` for this extension to work. [Read here to see how to install it](/harper-ls/README.md#installation).++## Packaging and Installing++### Requirements++- [`yarn`](https://yarnpkg.com)+- [`vsce`](https://github.com/microsoft/vscode-vsce)++### Steps++- Clone or download the Harper repository:++ ```console+ git clone https://github.com/elijah-potter/harper+ ```++- Navigate to `packages/vscode-plugin`.+- Install dependencies:++ ```console+ yarn install+ ```++- Package the extension:++ ```console+ vsce package+ ```++- Install the extension:++ ```console+ code --install-extension harper-0.0.1.vsix+ ```