Skip to content

Commit

Permalink
Removed garbage + added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
elijah-potter committed Jan 30, 2024
1 parent 9d43340 commit 2488fc8
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 3,033 deletions.
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<div id="header" align="center">
<h1>Harper</h1>
</div>

Harper is a an English grammar checker designed to be _just right._
I created it after years of shortcomings with the competition.

Grammarly was too expensive and too overbearing.
It's suggestions lacked context, and were often just plain _wrong_.
No to mention: it's a privacy nightmare.
Everything you write with Grammarly is sent to their servers.
Their privacy policy claims they don't sell the data, but that doesn't mean they don't use it to train large language models god knows what else.
Not only that, but the round-trip-time of the network request makes revising your work all the more tedious.

LanguageTool is great, if you have gigabytes of RAM to spare and are willing to download the ~16GB n-gram dataset.
Besides the memory requirements, I found LanguageTool too slow: it would take several seconds to lint even a moderate-size document.

That's why I created Harper: it is the grammar checker that fits my needs.
Not only does it take milliseconds to lint a document, take less than 1/50th of LanguageTool's memory footprint,
but it is also completely private.

It is even small enough to load via [WebAssembly.](https://harper.elijahpotter.dev)

## Installation

Binary releases are coming soon, so if you are looking for a single file download, you'll have to wait.

However, if you happen to have [Rust installed](https://www.rust-lang.org/tools/install), you're in luck!
To install `harper-ls`, the variant of Harper for text editors like Neovim, simply run:

```bash
cargo install harper-ls
```
2 changes: 1 addition & 1 deletion harper-core/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "harper-core"
version = "0.5.4"
version = "0.5.8"
edition = "2021"
description = "The language checker for artists."
license = "MIT OR Apache-2.0"
Expand Down
Loading

0 comments on commit 2488fc8

Please sign in to comment.