Document requirements

vweevers · Jun 29, 2019 · 99d9884 · 99d9884
1 parent 1fff6f3
commit 99d9884
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,11 @@ Lint and fix custom files:
 hallmark --fix CHANGELOG.md docs/*.md
 ```
 
+## Requirements
+
+- A `package.json` must exist, with a [`repository`](https://docs.npmjs.com/files/package.json#repository) property
+- The working directory must be a git repository.
+
 ## Opt-in Features
 
 ### Table of Contents