Skip to content

Commit

Permalink
docs: add install instruction
Browse files Browse the repository at this point in the history
Important addition while master tracks RC versions.
  • Loading branch information
dinoboff committed Jan 4, 2017
1 parent 4b9e9da commit a19a70a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,13 @@ See [USAGE.md](https://github.com/goldibex/targaryen/blob/master/USAGE.md) for m
Targaryen statically analyzes your security rules using [esprima](http://esprima.org). It then conducts two passes over the abstract syntax tree. The first pass, during the parsing process, checks the types of variables and the syntax of the rules for correctness. The second pass, during the testing process, evaluates the expressions in the security rules given a set of state variables (the RuleDataSnapshots, auth data, the present time, and any wildchildren).
## Install
```shell
npm install targaryen@3
```
## API
- `targaryen.database(rules: object|Ruleset, data: object|DataNode, now: null|number): Database`
Expand Down
2 changes: 1 addition & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To use either Jasmine or Chai, you'll need to get the Targaryen API. This is as
simple as

```bash
npm install --save-dev targaryen
npm install --save-dev targaryen@3
```

followed by
Expand Down

0 comments on commit a19a70a

Please sign in to comment.