From e96c79c2e8baad071ce7e4fb46670d9bf3ce51d6 Mon Sep 17 00:00:00 2001
From: Nicolas Giard <github@ngpixel.com>
Date: Tue, 30 Aug 2022 17:42:10 -0400
Subject: [PATCH] docs: update the dev/diff readme

---
 dev/diff/README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/dev/diff/README.md b/dev/diff/README.md
index 7b9838a90..d2faa3a6b 100644
--- a/dev/diff/README.md
+++ b/dev/diff/README.md
@@ -1 +1,22 @@
-# diff
+# Datatracker Diff Tool
+
+This tool facilitates testing 2 different datatracker instances (with their own database) and look for changes using the diff tool. Everything runs in docker containers.
+
+The source instance will use the code from where it is run. The target instance can be a remote tag / branch / commmit or another local folder.
+
+## Requirements
+
+- Node `16.x` or later
+- Docker
+
+## Usage
+
+1. From the `dev/diff` directory, run the command:
+```sh
+npm install
+```
+2. Then run the command:
+```sh
+node cli
+```
+3. Follow the on-screen instructions.