		@@ -5,8 +5,24 @@ # Bumbailiff

		Check out our [blog post](https://cucumber.io/blog/bdd/todo-or-not-todo/) to learn more about the concept behind this tool.
		Check out our [blog post](https://cucumber.io/blog/bdd/todo-or-not-todo/) to learn more about the concept behind this tool. Bumbailiff works on any git repository.

		Bumbailiff works on any git repository.

		## Installation

		There are several ways of installing and running bumbailiff.

		### Node.js / NPM

		If you have [Node.js](https://nodejs.org/en/) and [NPM](https://docs.npmjs.com/about-npm) installed, you can use [`npx`](https://docs.npmjs.com/cli/v7/commands/npx) to execute bumbailiff:

		npx bumbailiff

		You can add bumbailiff to your Node.js project:

		npm install --save-dev bumbailiff

		Or alternatively:

		yarn add --dev bumbailiff

		### Manual download

		Download and decompress the archive of this repository in the directory of your choice:
		@@ -25,2 +41,8 @@

		The maximum debt age is optional and defaults to 14.
		The maximum debt age is optional and defaults to 14.

		## Set up on your project

		After installing bumbailiff, you might want to set up a pre-push hook in your repository to prevent pushing if the tech debt limit has been reached:

		echo "#\!/usr/bin/env bash\nbumbailiff" >> .git/hooks/pre-push && chmod +x .git/hooks/pre-push

bumbailiff - npm Package Compare versions

New alerts