docs: add example gif

media/demo.tape

@@ -0,0 +1,76 @@
+# VHS documentation
+#
+# @see https://github.com/charmbracelet/vhs
+# 
+# ```
+# vhs < media/demo.tape
+# ```
+#
+# Output:
+#   Output <path>.gif               Create a GIF output at the given <path>
+#   Output <path>.mp4               Create an MP4 output at the given <path>
+#   Output <path>.webm              Create a WebM output at the given <path>
+#
+# Require:
+#   Require <string>                Ensure a program is on the $PATH to proceed
+#
+# Settings:
+#   Set FontSize <number>           Set the font size of the terminal
+#   Set FontFamily <string>         Set the font family of the terminal
+#   Set Height <number>             Set the height of the terminal
+#   Set Width <number>              Set the width of the terminal
+#   Set LetterSpacing <float>       Set the font letter spacing (tracking)
+#   Set LineHeight <float>          Set the font line height
+#   Set LoopOffset <float>%         Set the starting frame offset for the GIF loop
+#   Set Theme <json|string>         Set the theme of the terminal
+#   Set Padding <number>            Set the padding of the terminal
+#   Set Framerate <number>          Set the framerate of the recording
+#   Set PlaybackSpeed <float>       Set the playback speed of the recording
+#
+# Sleep:
+#   Sleep <time>                    Sleep for a set amount of <time> in seconds
+#
+# Type:
+#   Type[@<time>] "<characters>"    Type <characters> into the terminal with a
+#                                   <time> delay between each character
+#
+# Keys:
+#   Backspace[@<time>] [number]     Press the Backspace key
+#   Down[@<time>] [number]          Press the Down key
+#   Enter[@<time>] [number]         Press the Enter key
+#   Space[@<time>] [number]         Press the Space key
+#   Tab[@<time>] [number]           Press the Tab key
+#   Left[@<time>] [number]          Press the Left Arrow key
+#   Right[@<time>] [number]         Press the Right Arrow key
+#   Up[@<time>] [number]            Press the Up Arrow key
+#   Down[@<time>] [number]          Press the Down Arrow key
+#   Ctrl+<key>                      Press the Control key + <key> (e.g. Ctrl+C)
+#
+# Display:
+#   Hide                            Hide the subsequent commands from the output
+#   Show                            Show the subsequent commands in the output
+
+Output media/demo.gif
+
+Hide
+Require npx
+
+#Set Shell bash
+Set FontSize 17
+Set Width 1200
+Set Height 600
+Set Padding 24
+Set LoopOffset 75%
+
+Type " "
+
+Sleep 980ms
+Backspace 1
+Show
+Type "npx tsx src/example.ts"
+Sleep 500ms
+Enter
+Show
+
+Sleep 8s
+Sleep 8s

package.json

@@ -50,6 +50,7 @@
     "husky": "^8.0.2",
     "lint-staged": "^13.0.3",
     "npm-run-all": "^4.1.5",
+    "ora": "^6.1.2",
     "prettier": "^2.8.0",
     "tsup": "^6.5.0",
     "tsx": "^3.12.1",

readme.md

@@ -1,3 +1,7 @@
+<p align="center">
+  <img alt="Example usage" src="/media/demo.gif">
+</p>
+
 # ChatGPT API <!-- omit in toc -->
 
 > Node.js client for the unofficial [ChatGPT](https://openai.com/blog/chatgpt/) API.

src/example.ts

@@ -1,4 +1,5 @@
 import dotenv from 'dotenv-safe'
+import { oraPromise } from 'ora'
 
 import { ChatGPTAPI } from './chatgpt-api'
 
@@ -11,9 +12,12 @@ async function main() {
   const api = new ChatGPTAPI({ sessionToken: process.env.SESSION_TOKEN })
   await api.ensureAuth()
 
-  const response = await api.sendMessage(
+  const prompt =
     'Write a python version of bubble sort. Do not include example usage.'
-  )
+
+  const response = await oraPromise(api.sendMessage(prompt), {
+    text: prompt
+  })
 
   return response
 }