@comake/skl-js-engine/README.md

Standard Knowledge Language Javascript Engine

[![npm version](https://badge.fury.io/js/@comake%2Fskl-js-engine.svg)](https://badge.fury.io/js/@comake%2Fskl-js-engine)

# SKL Javascript Engine

This is a Javascript implementation of a Standard Knowledge Language Engine for [Standard Knowledge Language (SKL)](https://www.comake.io/skl). It is written in Typescript and follows the [SKL Engine specification](https://docs.standardknowledge.com/get-started/engine).


## How to use SKL Javascript Engine

#### 1. Install via npm or yarn:

```shell
npm install @comake/skl-js-engine
yarn add @comake/skl-js-engine
```

#### 2. Define Schemas

We will be posting more documentation on schemas soon.

#### 3. Write code

Once you have schemas defined for your domain, all you have to do is write code using the Verbs and Nouns in your schema to build your application logic.

#### Browser support
To use SKL Javascript Engine in a browser, you'll need to use a bundling tool such as Webpack, Rollup, Parcel, or Browserify. Some bundlers may require a bit of configuration, such as setting browser: true in rollup-plugin-resolve.

## How to contribute

To clone the repo, execute the following commands in your terminal:
```shell
git clone https://github.com/comake/skl-js-engine.git
cd skl-js-engine
npm ci
```

# License & Copyright

SKL Javascript Engine is open-source with certain limitations. See the [LICENSE](LICENSE.md) file for more info.

Copyright (c) 2024, Comake, Inc.