From c389cb8add03116b32147a17b2a40d91f2be0852 Mon Sep 17 00:00:00 2001
From: Ayman Nadeem <aymannadeem@github.com>
Date: Tue, 10 Sep 2019 15:13:39 -0400
Subject: [PATCH] create README

---
 semantic-ast/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 semantic-ast/README.md

diff --git a/semantic-ast/README.md b/semantic-ast/README.md
new file mode 100644
index 000000000..aacc2e976
--- /dev/null
+++ b/semantic-ast/README.md
@@ -0,0 +1,28 @@
+# semantic-ast
+
+This package has two goals:
+
+1. Develop a library that will produce ASTs;
+2. Provide a command line tool that will output ASTs in supported formats.
+
+### Design
+
+#### The CLI interface
+
+To output ASTs, run the following command passing in the file containing source code you intend to parse, with the option of specifying which format you'd like to return:
+
+```
+semantic-ast [source-file] --option
+```
+
+An example command is:
+
+```
+semantic-ast foo.js --sexpression
+```
+
+This will generate an AST
+
+```
+some AST
+```