From 143b7364750a9c592c6d42d37e2842828f22605e Mon Sep 17 00:00:00 2001
From: Adithya Kumar <adithya@composewell.com>
Date: Fri, 26 Jul 2024 04:18:53 +0530
Subject: [PATCH] Update the packdiff readme

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e01ec7a..8f8a9fe 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,19 @@
-packdiff diff streamly-process rev1 streamly-process rev2
+# packdiff
+
+**Usage:**
+
+```
+packdiff diff <package-name> <rev1> <package-name> <rev2>
+```
+
+**Limitations:**
+
+Packdiff uses the hoogle file created by haddock to generate and compare the
+difference between multiple versions of a package
+
+1. The API for modules in the `other-modules` sections is not generated or
+   compared.
+2. The re-exported module is just considered a re-exported module. The API of
+   the re-exported module isn't merged with the module that re-exports it.
+
+The 2nd limitation can be fixed.