Skip to content

Commit

Permalink
Add usage part in README
Browse files Browse the repository at this point in the history
  • Loading branch information
xxuejie committed Mar 12, 2020
1 parent 1533773 commit 5442d27
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# moleculec-es
ECMAScript plugin for the molecule serialization system

# Usage

First, download precompiled binary from [releases](https://github.com/xxuejie/moleculec-es/releases) page, and put the binary in our PATH. You could also clone and build the project from source. The only dependency is Golang here.

```
$ cargo install moleculec
$ moleculec --language - --schema-file "your schema file" --format json > /tmp/schema.json
$ moleculec-es -inputFile /tmp/schema.json -outputFile "your JS file"
```

Generated file from this project follows latest ECMAScript standard, it is also orgnaized as an ECMAScript module to allow for tree shaking.

0 comments on commit 5442d27

Please sign in to comment.