refactor(#16): Move demo files to demo directory

README.md

@@ -11,6 +11,7 @@
 ## Features
 
 ![Demo](./assets/demo.gif)
+*(Want to create a demo like this? Check out the [recording documentation](demo/recording-demo.md))*
 
 - **Standalone Executable** - perfect for wrapping slow commands in bash scripts
 - **16 built-in spinner styles** - dots, line, arc, bounce, and more

demo/demo.lua

@@ -1,6 +1,7 @@
 #!/usr/bin/env -S lx lua
 --- Demo script for Roda terminal spinner library
---- Run this script to see all features in action
+--- Run this script using: just demo run
+--- Record this script using: just demo record
 
 local system = require("system")
 

demo.tape → demo/demo.tape

@@ -6,14 +6,14 @@
 #   lx install  (or ensure roda is in package.path)
 #
 # Generate GIF:
-#   vhs demo.tape
+#   just demo record
 #
 # Generate MP4:
-#   vhs demo.tape --output assets/demo.mp4
+#   vhs demo.tape --output ../assets/demo.mp4
 
 # Output configuration
-Output assets/demo.gif
-Set Shell "zsh"
+Output ../assets/demo.gif
+Set Shell "bash"
 
 # Set up a 1200x600 terminal
 Set FontSize 30
@@ -27,7 +27,7 @@ Set PlaybackSpeed 1
 Sleep 500ms
 
 # Show command being typed
-Type "lua demo.lua"
+Type "just demo run"
 Sleep 300ms
 Enter
 

demo/mod.just

@@ -0,0 +1,8 @@
+[doc("Run the demo script to showcase Roda features")]
+run:
+    lx lua -- demo/demo.lua
+
+[doc("Record the demo and generate a GIF using VHS")]
+record:
+    cd demo && vhs demo.tape
+

demo/recording-demo.md

@@ -0,0 +1,51 @@
+# Recording the Demo GIF
+
+Generate the demo GIF using [VHS](https://github.com/charmbracelet/vhs).
+
+## Prerequisites
+
+```bash
+brew install vhs          # Terminal recorder
+lx install                # Or ensure roda is in package.path
+```
+
+## Demo Script
+
+`demo/demo.lua` showcases Roda features:
+- Basic spinner usage
+- Terminal states (succeed, fail, warn, info)
+- Dynamic text updates
+- Different spinner styles
+
+Run interactively: `just demo run`
+
+## Recording
+
+Generate the GIF:
+```bash
+just demo record
+```
+
+This runs `vhs` with `demo/demo.tape`, producing `assets/demo.gif`.
+
+## Tape Configuration
+
+`demo/demo.tape` configures the recording:
+```tape
+Output ../assets/demo.gif
+Set Shell "bash"
+Set FontSize 30
+Set Width 1200
+Set Height 600
+Set TypingSpeed 50ms
+Set PlaybackSpeed 1
+```
+
+Customize settings like `FontSize`, `Width`, `Height` as needed.
+
+## Tips
+
+- Use a dark terminal background for contrast
+- Ensure terminal uses a monospace font (JetBrains Mono, Fira Code)
+- The demo runs ~18 seconds; adjust `Sleep` in the tape accordingly
+- For MP4 output: `vhs demo.tape --output ../assets/demo.mp4`

justfile

@@ -12,6 +12,8 @@ set unstable := true
 
 # Enable latest Just features
 
+mod demo
+
 set dotenv-load := true
 
 # Auto-load .env files