Add short description of JS parser to readme, see #67

tdewolff · Nov 19, 2020 · 58df9bc · 58df9bc
1 parent a539aff
commit 58df9bc
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/css/README.md b/css/README.md
@@ -162,7 +162,6 @@ func main() {
 	}
 	fmt.Println(out)
 }
-
 ```
 
 ## License

diff --git a/js/README.md b/js/README.md
@@ -65,6 +65,15 @@ func main() {
 }
 ```
 
+## Parser
+### Usage
+The following parses a file and returns an abstract syntax tree (AST).
+``` go
+ast, err := js.NewParser(parse.NewInputString("if (state == 5) { console.log('In state five'); }"))
+```
+
+See [ast.go](https://github.com/tdewolff/parse/blob/master/js/ast.go) for all available data structures that can represent the abstact syntax tree.
+
 ## License
 Released under the [MIT license](https://github.com/tdewolff/parse/blob/master/LICENSE.md).