From ac0b4ced8979f696a6c497ad3eed9139649b0d61 Mon Sep 17 00:00:00 2001
From: Max Zuo <max.zuo@gmail.com>
Date: Mon, 24 Jun 2024 17:04:11 -0400
Subject: [PATCH] README first draft

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 22a060f..b717ee6 100644
--- a/README.md
+++ b/README.md
@@ -27,4 +27,13 @@ tar -xzvf tmp/linux64/*.tar.gz -C tmp/ --strip-components=1
 # clean up
 rm -rf tmp
 # Make sure to add fast-downward.sif and VAL to your PATH or make aliases.
-```
\ No newline at end of file
+```
+
+## Basic Usage
+To evaluate a PDDL problem description, we can use the `planetarium.evaluate` module:
+```python
+from planetarium import evaluate
+...
+evaluate.evaluate(gt_pddl_str, pred_pddl_str)
+```
+The supported domains are `blocksworld` and `gripper` domains.