bali-type-compiler/README.md

This library provides a JavaScript based implementation for the compiler for the Bali Virtual Processor.

## The Bali Type Compiler™ (v2)
<img src="https://craterdog.com/images/CraterDogLogo.png" width="50%">

**_WARNING_**
_This project is currently being converted to version 2 of the base components. It is not yet ready for prime-time._

### Quick Links
For more information on this project click on the following links:
 * [project documentation](https://github.com/craterdog-bali/js-bali-type-compiler/wiki)
 * [node packages](https://www.npmjs.com/package/bali-type-compiler)
 * [release notes](https://github.com/craterdog-bali/js-bali-type-compiler/wiki/release-notes)
 * [code examples](https://github.com/craterdog-bali/js-bali-type-compiler/wiki/code-examples)

### Getting Started
To install this NodeJS package, execute the following command:
```
npm install bali-type-compiler
```
Then add the following line to your NodeJS modules:
```
const debug = 1;  // debugging level: [0..3]
const compiler = require('bali-type-compiler').api(debug);
```

### Contributing
Project contributors are always welcome. Create a
[fork](https://github.com/craterdog-bali/js-bali-type-compiler) of the project and add cool
new things to the project. When you are ready to contribute the changes create a subsequent
["pull request"](https://help.github.com/articles/about-pull-requests/). Any questions and
comments can be sent to [craterdog@gmail.com](mailto:craterdog@gmail.com).