From 44a6acaaaea15ac4bce7c81bd4ac584964837129 Mon Sep 17 00:00:00 2001 From: greatsquare0 Date: Thu, 8 Aug 2024 16:02:55 -0300 Subject: [PATCH] Readme update and hotfixes --- README.md | 18 ++++++++++++++++-- config_template.toml | 1 + 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d8b7d58..dc96c55 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# tweenode +# Tweenode + +> 🚨 highly experimental A neat NPM package and wrapper for Tweego, downloads binaries from Tweego repo and expose a simple way to compile the story on JS @@ -8,7 +10,19 @@ Created with [Bun-lib-starter](https://github.com/wobsoriano/bun-lib-starter) Based in the tweego-install script on [sugarcube-starter](https://github.com/nijikokun/sugarcube-starter/) by nijikokun -## Setup +## Basic usage + +```js +import tweenode from 'tweenode' + +tweenode({ + input: 'path/to/storyFolder' + output: 'path/to/output.html' +}) + +``` + +## Development ```bash # install dependencies diff --git a/config_template.toml b/config_template.toml index d321a67..7e8be53 100644 --- a/config_template.toml +++ b/config_template.toml @@ -2,6 +2,7 @@ [tweego.binaries] acceptable_plataforms = ['win32', 'darwin', 'linux'] +acceptable_arch = ['x86', 'x64'] version = 'v2.1.1' [tweego.binaries.win32]