diff --git a/README.md b/README.md index fd9fc60..d617608 100644 --- a/README.md +++ b/README.md @@ -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 `. + +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.