From a2ffa79f61a947a84f3b279769af08bed8038001 Mon Sep 17 00:00:00 2001 From: AaronTackeQC <156931896+AaronTackeQC@users.noreply.github.com> Date: Fri, 16 Aug 2024 17:18:16 +0200 Subject: [PATCH] Update README.md with Dominik's suggestion Co-authored-by: DominikZuercherQC <115215632+DominikZuercherQC@users.noreply.github.com> --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 20fd157..44c9b79 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,11 @@ [![pypi-version](https://img.shields.io/pypi/v/tabulardelta.svg?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/tabulardelta) [![python-version](https://img.shields.io/pypi/pyversions/tabulardelta?logoColor=white&logo=python&style=flat-square)](https://pypi.org/project/tabulardelta) -TabularDelta simplifies the comparison of diverse tables, like SQL tables or Pandas DataFrames. It can both find small deviations in largely similar tables, as well as provide an overview of more structural changes. +TabularDelta helps to automate and simplify the often tedious and manual process of comparing relational data. +The TabularDelta protocol defines a representation of the differences between two tables. +"Comparators" are used to generate such a representation from two table objects. The exchangeability of the comparators allows for varying table input formats like SQL tables or Pandas DataFrames. +"Formatters" allow to present the differences in different output formats depending on the desired usecase. +The flexibility in the output format allows to find small deviations in largely similar tables or provide an overview of more structural changes. To compare two tables, first select a comparator that supports the table format. Now select any formatter that best suits your use case to obtain a visualization of the result.