From 97d821853ca9987f1fb84b7202abfbcbd1cd48a6 Mon Sep 17 00:00:00 2001
From: Niklas Fors <niklas.fors@cs.lth.se>
Date: Thu, 5 Jul 2018 13:51:32 +0200
Subject: [PATCH] Update README.md

---
 README.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index dd28cff..e7ca89e 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,36 @@
 # RelAST Preprocessor
 
-Run preprocessor on train benchmark (output written to standard output)
+Run preprocessor on train benchmark (output written to standard output):
 
 	$ ant jar
+	$ cat examples/TrainBenchmark.relast
 	$ java -jar relast-compiler.jar examples/TrainBenchmark.relast
 
-Run preprocessor and write to files
+Run preprocessor and write output to files:
 
 	$ java -jar relast-compiler.jar examples/TrainBenchmark.relast --file
 	$ cat examples/TrainBenchmarkGen.ast
 	$ cat examples/TrainBenchmarkGen.jadd
 
-Run test cases
+Run test cases:
 
 	$ cd test
-	$ make
\ No newline at end of file
+	$ make
+
+Supported relations:
+
+	// Directed relations
+	A.b    -> B;
+	A.b?   -> B;
+	A.bs*  -> B;
+
+	// Bidirectional relations
+	A.b   <-> B.a;
+	A.b   <-> B.a?;
+	A.b   <-> B.as*;
+	A.b?  <-> B.a;
+	A.b?  <-> B.a?;
+	A.b?  <-> B.as*;
+	A.bs* <-> B.a;
+	A.bs* <-> B.a?;
+	A.bs* <-> B.as*;
-- 
GitLab