CASP

CASP.md

@@ -0,0 +1,44 @@
+# CASP - Canvas And SVG Plotter
+<div align="center">
+<img src="icons/CASP.svg" width="300px" height="auto">
+</div>
+
+## Description
+
+A library that plots static charts using DOM manipulation and HTML Canvas. Written in TypeScript and compiled to Vanilla JavaScript. No dependencies and no frameworks, just regular DOM Manipulation. The library has two formats, an NPM Package and Script-Style. The library is efficient, lightweight and highly customizable. Script-Style version has a standalone file for each chart type, allowing it to be tree-shakable.
+
+## Features
+
+## Publish Formats
+
+- NPM Package
+- Script-Style JS
+
+## Branches
+
+- **`main`**  
+  NPM Package
+- **`web`**  
+  Terser minified script-style plain JS
+- **`doc-src`**  
+  Docusaurus Source Code
+- **`gh-pages`**  
+  Docusaurus output, CASP website
+
+## Automations
+
+- **`publish`**  
+  - Triggered by pushing a Tag at `main`
+  - Creates `dist` and realeases to NPM
+  - Zips NPM
+  - Parses `dist` to Script-Style JS and push to `web`
+  - Zips Script-Style JS
+  - Reads `CHANGELOG` at `main` and extract latest
+  - Creates release at `main` with the extracted changelog and two zips.
+- **`deploy-doc`**
+  - Triggered by pushing to `doc-src`
+  - Build website
+  - Push output to `gh-pages`
+- **`deploy`**  
+  - **Default GitHub Pages Workflow**
+  - deploy `gh-pages` to [devdiggas.github.io/CASP](https://devdiggas.github.io/CASP)