Write a project description
This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.
$ npm -v && node -v
6.4.1
v8.16.0
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
BEFORE YOU INSTALL: please read the prerequisites
Start with cloning this repo on your local machine:
$ git clone https://github.com/arcweave/arcscript-interpreters.git
$ cd arcscript-interpreters/JavaScript
To install and set up the library, run:
$ npm install -S @arcweave/arcscript
Or if you prefer using Yarn:
$ yarn add --dev @arcweave/arcscript
$ npm run build
$ npm test
This task will create a distribution version of the project
inside your local dist/
folder
TODO: Write API
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Add your changes:
git add .
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
TODO: Write credits
TODO: Write license