diff --git a/README.md b/README.md index b4e723a..7428cb1 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ `lw` is a terminal-based tool for creating and managing personal logs directly from the command line. It enables you to quickly record, edit, and review your achievements, notes, or any personal entries using an interactive text user interface (TUI). +![Demo GIF](./assets/demo.gif) + --- ## Features diff --git a/assets/demo.gif b/assets/demo.gif new file mode 100644 index 0000000..9944735 Binary files /dev/null and b/assets/demo.gif differ diff --git a/assets/demo.mp4 b/assets/demo.mp4 new file mode 100644 index 0000000..eaff474 Binary files /dev/null and b/assets/demo.mp4 differ diff --git a/assets/demo.tape b/assets/demo.tape new file mode 100644 index 0000000..92e157e --- /dev/null +++ b/assets/demo.tape @@ -0,0 +1,85 @@ +# VHS documentation +# +# Output: +# Output .gif Create a GIF output at the given +# Output .mp4 Create an MP4 output at the given +# Output .webm Create a WebM output at the given +# +# Require: +# Require Ensure a program is on the $PATH to proceed +# +# Settings: +# Set FontSize Set the font size of the terminal +# Set FontFamily Set the font family of the terminal +# Set Height Set the height of the terminal +# Set Width Set the width of the terminal +# Set LetterSpacing Set the font letter spacing (tracking) +# Set LineHeight Set the font line height +# Set LoopOffset % Set the starting frame offset for the GIF loop +# Set Theme Set the theme of the terminal +# Set Padding Set the padding of the terminal +# Set Framerate Set the framerate of the recording +# Set PlaybackSpeed Set the playback speed of the recording +# Set MarginFill Set the file or color the margin will be filled with. +# Set Margin Set the size of the margin. Has no effect if MarginFill isn't set. +# Set BorderRadius Set terminal border radius, in pixels. +# Set WindowBar Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight) +# Set WindowBarSize Set window bar size, in pixels. Default is 40. +# Set TypingSpeed