Merge pull request #2 from domdere/topic/readme

README.md
domdere · Feb 5, 2019 · 0c71464 · 0c71464
2 parents 41d79b3 + 0da4dd0
commit 0c71464
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+An action that runs `hlint` checks over Haskell code.
+
+If there are errors found in the Haskell code then the action will fail.
+
+Example workflow:
+
+```
+workflow "Code Checks" {
+  on = "push"
+  resolves = ["haskell-lint"]
+}
+
+action "haskell-lint" {
+  uses = "domdere/haskell-lint-action@master"
+}
+```
+
+## TODOs
+
+- [ ] Opens proper GitHub check runs
+- [ ] Annotates lines in PR with suggestions