Skip to content

Commit

Permalink
update README with new API method + update changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
jcubic committed Mar 9, 2018
1 parent b112a38 commit fb76838
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 6 deletions.
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
## 0.3.0
## Next
### Features
* exec api method
### Bugfixes
* fix processing of multiple backquote and unquote


## 0.2.1/0.2.2
* fix build system

Expand Down
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## LIPS is Pretty Simple

[![npm](https://img.shields.io/badge/npm-DEV-blue.svg)](https://www.npmjs.com/package/@jcubic/lips)
[![travis](https://travis-ci.org/jcubic/jquery.terminal.svg?branch=devel&3ee6f60f223475a6e74d9a6b14423f010d1f7faa)](https://travis-ci.org/jcubic/jquery.terminal)
[![Coverage Status](https://coveralls.io/repos/github/jcubic/lips/badge.svg?branch=devel&90f3a78d04af7d30b1ab1a6b7b5d9c13)](https://coveralls.io/github/jcubic/lips?branch=devel)
[![travis](https://travis-ci.org/jcubic/jquery.terminal.svg?branch=devel&b112a38747fbb72e79056851c1568eabb926a7af)](https://travis-ci.org/jcubic/jquery.terminal)
[![Coverage Status](https://coveralls.io/repos/github/jcubic/lips/badge.svg?branch=devel&653892f4acf8e13e87c4070c8e5eacd1)](https://coveralls.io/github/jcubic/lips?branch=devel)



Expand Down Expand Up @@ -33,14 +33,24 @@ https://cdn.rawgit.com/jcubic/lips/master/index.js
## Usage

```javascript
var {exec} = require('@jcubic/lips');

exec(string).forEach(function(result) {
console.log(result);
});
```

there is also longer version if you want to split the process of evaluation:

```
var {parse, tokenize, evaluate} = require('@jcubic/lips');
parse(tokenize(string)).forEach(function(code) {
evaluate(code);
});
```

`evaluate` function also accept second argument, which is Environment.
`evaluate` and `exec` functions also accept second argument, which is Environment.
By default it's `lips.global_environment`. You can use it if you want to
have separated instances of the interpreter.

Expand Down
12 changes: 11 additions & 1 deletion templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,24 @@ https://cdn.rawgit.com/jcubic/lips/master/index.js
## Usage

```javascript
var {exec} = require('@jcubic/lips');

exec(string).forEach(function(result) {
console.log(result);
});
```

there is also longer version if you want to split the process of evaluation:

```
var {parse, tokenize, evaluate} = require('@jcubic/lips');
parse(tokenize(string)).forEach(function(code) {
evaluate(code);
});
```

`evaluate` function also accept second argument, which is Environment.
`evaluate` and `exec` functions also accept second argument, which is Environment.
By default it's `lips.global_environment`. You can use it if you want to
have separated instances of the interpreter.

Expand Down

0 comments on commit fb76838

Please sign in to comment.