docs: update the dev/diff readme

2022-08-30 17:42:10 -04:00 · 2022-08-30 17:42:10 -04:00 · e96c79c2e8
parent 79a34e2f4d
commit e96c79c2e8
1 changed files with 22 additions and 1 deletions
--- 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.