Updated readme.md

.github/workflows/Manual_Release.yml → .github/workflows/release_manual.yml

@@ -1,4 +1,4 @@
-name: Release
+name: Manual Release
 
 on: workflow_dispatch
 

README.md

@@ -1,6 +1,21 @@
-# Tweenode
 
-A neat NPM package and wrapper for [Tweego](https://github.com/tmedwards/tweego), downloads binaries from Tweego repo and expose a JS API
+<!-- <div align='center'>
+  <img align='center' height='128px' alt='Logo' src=''>
+</div> -->
+
+<h1 align='center'>Tweenode</h1>
+
+<p align='center'>
+  A neat NPM package and wrapper for Tweego, downloads binaries from Tweego repo and expose a JS API
+</p>
+
+<div align='center'>
+  <img alt="Version Badge" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgreatsquare0%2Ftweenode%2Frefs%2Fheads%2Fmain%2Fpackage.json&query=%24.version&label=Version">
+  <img alt="CI Workflow Status" src="https://img.shields.io/github/actions/workflow/status/greatsquare0/tweenode/ci.yml?style=flat&label=Testing">
+  <img alt="Build Workflow Status" src="https://img.shields.io/github/actions/workflow/status/greatsquare0/tweenode/release.yml?style=flat&label=Release">
+</div>
+
+---
 
 > Now on beta!
 
@@ -9,7 +24,7 @@ Aimed to be used with build scripts for more complex stories
 ## Basic usage
 
 ```js
-import {Tweenode, setupTweego} from 'tweenode'
+import { Tweenode, setupTweego } from 'tweenode'
 
 await setupTweego()
 
@@ -24,7 +39,6 @@ await tweego.process({
     fileName: 'path/to/output.html',
   },
 })
-
 ```
 
 ## Development
@@ -38,16 +52,16 @@ await tweego.process({
 # install dependencies
 pnpm install
 
-# test the app
+# test the library with Vitest
 pnpm run test
 
-# build the app, available under dist
+# build the library, available under dist/
 pnpm run build
 ```
 ---
 ### Special thanks to these projects (And the people behind them):
 
-
+[Tweego by tmedwards](https://github.com/tmedwards/tweego)
 [sugarcube-starter by nijikokun](https://github.com/nijikokun/sugarcube-starter/) (Main source of inspiration)
 [tweego-bin by double-a-stories](https://github.com/double-a-stories/tweego-bin)
 [tweego-node by mattrossman](https://github.com/mattrossman/tweego-node)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tweenode",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",