From ea9bb79ede58d02ce08da4cbb20400e2547a5f6c Mon Sep 17 00:00:00 2001
From: Jean-Yves Tinevez <tinevez@pasteur.fr>
Date: Thu, 25 Jul 2024 11:03:15 +0200
Subject: [PATCH] Update README.md - add a basic description.

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 0bc3061..554ba7c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,7 @@
 [![Build Status](https://github.com/trackmate-sc/TrackMate-Pairing/actions/workflows/build.yml/badge.svg)](https://github.com/trackmate-sc/TrackMate-Pairing/actions/workflows/build.yml)
 
+# TrackMate-Pairing
+
+A tool that allows for pairing together two [TrackMate](https://github.com/trackmate-sc/TrackMate) files, based on several distance metrics. 
+It builds pairs taken from the tracks of one file and the tracks of a second file. 
+This is used mainly to study how the distance of objects detected in two different channels evolve over time.