Skip to content

Commit

Permalink
tweak readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mike Reinstein committed Apr 12, 2019
1 parent 3b38521 commit f2bb138
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -4,7 +4,7 @@

a cassowary constraint solver. wraps [kiwi.js](https://www.npmjs.com/package/kiwi.js) with better ergonomics.

Declares a mini language to declare constraints in text rather than code using pegjs.
Declares a mini language to declare constraints in text rather than code.

## example

Expand Down Expand Up @@ -51,6 +51,10 @@ console.log(layout.getValues())

### how it works

The language is defined in a pegjs grammar, which generates a parser javascript module. That module is
capable of taking a string of source code as input, and produces json containing all the parsed tokens.
These tokens are turned into kiwi.js constraints and variables.

```
┌-----------------┐ ┌----------------------------┐ ┌-----------┐
|input constraints| ┌-----┐ |intermediate representation | |ir to kiwi |
Expand Down

0 comments on commit f2bb138

Please sign in to comment.