ety/owncast-clipper
1
0
Fork 0
Code Issues Packages Activity

add usage

Browse Source
This commit is contained in:
Glyphscribe Ety 2025-04-27 12:31:32 -05:00
parent 042566f688
commit 26eb5860e6
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,5 +1,10 @@
# owncast-clipper
A simple and single-purpose bot which provides a clip command to Owncast stream viewers and automatically uploads to a specified PeerTube instance.
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
Once installed and configured, the clipper bot will silently sit in chat, waiting for a viewer to type `!clip <title>`.
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.
## ✅ Preparation
Beyond easily-discoverable information such as user credentials and base URLs, there are two pieces of information needed which non-technical users may struggle with: the Owncast Access Token and the PeerTube channel ID.