summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 28 insertions, 2 deletions
diff --git a/README.md b/README.md
index 42fe415..a51c057 100644
--- a/README.md
+++ b/README.md
@@ -11,14 +11,40 @@ You can find a vim plugin [here](https://github.com/vmchale/tomlcheck-vim).
### Binaries
-Head over to the [release page](link goes here) to see if your platform has
+Head over to the [release page](https://github.com/vmchale/tomlcheck/releases) to see if your platform has
binaries. Simply put it somewhere on your path.
### Cabal
-Install [GHC & cabal](https://www.haskell.org/downloads#minimal), then
+Install [GHC](https://www.haskell.org/ghc/download.html) along with
+[cabal](https://www.haskell.org/downloads#minimal), then
```bash
$ cabal update
$ cabal install tomlcheck
```
+
+## Known Deficiencies
+
+ * No Windows binaries
+ * Slow on large files (>7000 lines)
+
+## Cool Facts
+
+ * It's really fast
+ * It uses laziness to make checking schnell yet robust
+
+```
+-------------------------------------------------------------------------------
+ Language Files Lines Code Comments Blanks
+-------------------------------------------------------------------------------
+ Cabal 1 58 53 1 4
+ Haskell 3 40 28 4 8
+ Justfile 1 21 16 0 5
+ Markdown 2 42 42 0 0
+ TOML 3 87 78 0 9
+ YAML 1 9 9 0 0
+-------------------------------------------------------------------------------
+ Total 11 257 226 5 26
+-------------------------------------------------------------------------------
+```