@kurtharriger/jp-kernel/README.md

Generic Node.js kernel for the Jupyter notebook

# jp-kernel

`jp-kernel` is an [npm module](https://www.npmjs.com/) for implementing a
[Jupyter kernel](http://jupyter.readthedocs.io/en/latest/projects/kernels.html)
that interacts with a [Node.js session](https://github.com/n-riesco/nel).

`jp-kernel` is a spin-off library from
[IJavascript](https://github.com/n-riesco/ijavascript), a Javascript kernel for
the [Jupyter notebook](http://jupyter.org/). It is currently used to implement
the following kernels:

- [IJavascript](http://github.com/n-riesco/ijavascript)

- [jp-babel](http://github.com/n-riesco/jp-babel)

- [jp-coffeescript](http://github.com/n-riesco/jp-coffeescript)


## Anouncements

- Version v0.0.1 is the initial release based on IJavascript v5.0.13.


## Install

The latest stable release is published on
[`npm`](https://www.npmjs.com/package/jp-kernel) and can be installed by
running:

```sh
npm install jp-kernel
```

The master branch in the [github
repository](https://github.com/n-riesco/jp-kernel) provides the latest
development version and can be installed by:

```sh
git clone https://github.com/n-riesco/jp-kernel.git
cd jp-kernel
npm install
```


## Usage

The source code documentation generated using [JSDoc](http://usejsdoc.org/) can
be found [here](http://n-riesco.github.io/jp-kernel/).

For real examples of usage, see the source documentation for:

- [IJavascript](http://n-riesco.github.io/ijavascript/jsdoc/index.html)

- [jp-babel](http://n-riesco.github.io/jp-babel/)

- [jp-coffeescript](http://n-riesco.github.io/jp-coffeescript/)


# Contributions

First of all, thank you for taking the time to contribute. Please, read
[CONTRIBUTING.md](CONTRIBUTING.md) and use the [issue
tracker](https://github.com/n-riesco/jp-kernel/issues) for any contributions:
support requests, bug reports, enhancement requests, pull requests, ...