From fc3ccae7e981ae3e0eeb5e44ecd3502a51141f63 Mon Sep 17 00:00:00 2001 From: Robert Masen Date: Thu, 24 Nov 2022 13:25:23 -0600 Subject: [PATCH] chore: add note to readme about js modules --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2796115..3447bec 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,10 @@ The two major pieces that users will interact with are the `Parser` struct and t The parser struct will be the main way to convert text into an `AST`. Conveniently `Parser` implements `Iterator` over `Result`, -this means that you can evaluate your JS in pieces from top to bottom. +this means that you can evaluate your JS in pieces from top to bottom. + +> Note: By default the `Parser` will not be able to handle js module features, +> [see the module example](./examples/simple_module.rs) for details on how to parse js modules ### Iterator Example