Readme update and hotfixes

greatsquare0 · Aug 8, 2024 · 44a6aca · 44a6aca
1 parent a718ccf
commit 44a6aca
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git 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
@@ -2,6 +2,7 @@
 
 [tweego.binaries]
 acceptable_plataforms = ['win32', 'darwin', 'linux']
+acceptable_arch = ['x86', 'x64']
 version = 'v2.1.1'
 
 [tweego.binaries.win32]