clarify usage

This commit is contained in:
Glyphscribe Ety 2025-04-27 12:33:23 -05:00
parent 26eb5860e6
commit 324526ebe1

View File

@ -2,7 +2,7 @@
A simple and single-purpose bot which provides a clip command to Owncast stream viewers and automatically uploads to a specified PeerTube instance. A functional work-in-progress. A simple and single-purpose bot which provides a clip command to Owncast stream viewers and automatically uploads to a specified PeerTube instance. A functional work-in-progress.
## 🖱️ Usage ## 🖱️ Usage
Once installed and configured, the clipper bot will silently sit in chat, waiting for a viewer to type `!clip <title>`. Once installed and configured, the clipper bot will silently sit in chat, waiting for a viewer to type `!clip <title>`. Once uploaded to PeerTube, a link to the clip will be posted in chat as the clipper bot user.
If a title is provided, it will be used as the title of the clip in PeerTube. If not, the clipper's disply name and a timestamp will be used instead. If a title is provided, it will be used as the title of the clip in PeerTube. If not, the clipper's disply name and a timestamp will be used instead.