docs: adding repo badges

Author: yawetse

README.md

@@ -1,3 +1,140 @@
 # jsonstack-math
-math, matrix and other helpers
+linear algebra, math, matrix and other helpers
 
+# JSONSTACK Math
+ [![Coverage Status](https://coveralls.io/repos/github/repetere/jsonstack-math/badge.svg?branch=main)](https://coveralls.io/github/repetere/jsonstack-math?branch=main) [![Release](https://github.com/repetere/jsonstack-math/actions/workflows/release.yml/badge.svg)](https://github.com/repetere/jsonstack-math/actions/workflows/release.yml)
+
+## Description
+
+**JSONSTACK Math** is a module that ...WIP.
+
+### Jump right in
+
+... is designed so software engineers and machine learning engineers can ...WIP.
+
+### Usage
+
+The idea behind ... WIP.
+
+### What's included
+...WIP...
+ - tbd
+ - tbd
+## Installation
+
+```sh
+$ npm i @jsonstack/math
+```
+
+<link id="viewx-style-style-0" rel="stylesheet" type="text/css" href="https://unpkg.com/[email protected]/styles/darkula.css">
+
+---
+### jsonstack-math Manual
+ - [Getting Started](https://repetere.github.io/jsonstack-math/manual/getting-started/index.html)
+ - Working With Data
+   - [Data Fetching](https://repetere.github.io/jsonstack-math/manual/data-fetching/index.html)
+   - [Feature Engineering](https://repetere.github.io/jsonstack-math/manual/feature-engineering/index.html)
+ - Working With Models
+   - [Model Training](https://repetere.github.io/jsonstack-math/manual/model-training/index.html)
+   - [Model Evaluation](https://repetere.github.io/jsonstack-math/manual/model-evaluation/index.html)
+   - [Model Predictions](https://repetere.github.io/jsonstack-math/manual/model-predictions/index.html)
+   - [Saving and Loading Models](https://repetere.github.io/jsonstack-math/manual/saving-and-loading-models/index.html) 
+ - [Advanced Topics](https://repetere.github.io/jsonstack-math/manual/advanced-topics/index.html)
+   - [jsonstack-math & JML Spec](https://repetere.github.io/jsonstack-math/manual/spec/index.html)
+   - [Examples](https://repetere.github.io/jsonstack-math/manual/examples/index.html)
+   - [Full API Docs](https://repetere.github.io/jsonstack-math/)
+---
+
+### Basic Usage
+```typescript
+import * as tf from '@tensorflow/tfjs-node';
+import { getModel, setBackend, } from '@jsonstack/jsonstack-math';
+
+//set tensorflow
+setBackend(tf);
+
+//Iris Dataset e.g from https://raw.githubusercontent.com/repetere/modelx-model/master/src/test/mock/data/iris_data.csv
+const type = 'ai-classification';
+const dataset = [
+  {
+    "sepal_length_cm": 5.1,
+    "sepal_width_cm": 3.5,
+    "petal_length_cm": 1.4,
+    "petal_width_cm": 0.2,
+    "plant": "Iris-setosa",
+  },
+//  ...
+  {
+    "sepal_length_cm": 7.0,
+    "sepal_width_cm": 3.2,
+    "petal_length_cm": 4.7,
+    "petal_width_cm": 1.4,
+    "plant": "Iris-versicolor",
+  },
+  // ...
+  {
+    "sepal_length_cm": 5.9,
+    "sepal_width_cm": 3.0,
+    "petal_length_cm": 5.1,
+    "petal_width_cm": 1.8,
+    "plant": "virginica",
+  }
+]
+const inputs = ['sepal_length_cm','sepal_width_cm','petal_length_cm','petal_width_cm', ];
+const outputs = [ 'plant',];
+const on_progress = ({ completion_percentage, loss, epoch, status, logs, defaultLog, }) => { 
+  console.log({ completion_percentage, loss, epoch, status, logs, defaultLog, });
+}
+const IrisModel = await getModel({
+  type,
+  dataset,
+  inputs,
+  outputs,
+  on_progress,
+}); 
+await IrisModel.trainModel()
+const predictions = await IrisModel.predictModel({ 
+  prediction_inputs:[
+    { sepal_length_cm: 5.1, sepal_width_cm: 3.5, petal_length_cm: 1.4, petal_width_cm: 0.2, },
+    { sepal_length_cm: 5.9, sepal_width_cm: 3.0, petal_length_cm: 5.1, petal_width_cm: 1.8, },
+  ],
+}); // => [ { plant:'Iris-setosa' }, { plant:'Iris-virginica' }, ]
+
+```
+
+## Example ##
+<iframe width="100%" height="500" src="https://jsfiddle.net/yawetse/4ph1vwes/21/embedded/result,js,html,css,resources/dark/" allowfullscreen="allowfullscreen" allowpaymentrequest frameborder="0"></iframe>
+
+### Development
+
+Note *Make sure you have typescript installed*
+
+```sh
+$ npm i -g typescript 
+```
+
+For generating documentation
+
+```sh
+$ npm run doc
+```
+
+### Notes
+
+Check out [https://repetere.github.io/jsonstack-math/](https://repetere.github.io/jsonstack-math/) for the full jsonstack-math Documentation
+
+### Testing
+
+```sh
+$ npm test
+```
+
+### Contributing
+
+Fork, write tests and create a pull request!
+
+License
+
+----
+
+MIT