From 99d988431315050a1b346a4339e23b80cbf954d4 Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sat, 29 Jun 2019 09:34:16 +0200 Subject: [PATCH] Document requirements --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 91d71db..7a29f2a 100644 --- 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