From 34c077798b177c73756c2a0af893897287079955 Mon Sep 17 00:00:00 2001 From: neppa Date: Fri, 6 Oct 2023 14:22:42 -0400 Subject: [PATCH] Update README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 4771ed2..abbdfc7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ # SmugBot +A twitch chatbot written in Rust +### Cargos +* Twitch chat: https://docs.rs/twitch-irc/5.0.1/twitch_irc/ +* Env reading: https://docs.rs/dotenv/0.15.0/dotenv/index.html + +### Usage +1. Get twitch OAUTH key +2. Add the OAUTH key (without 'oauth:') to .env +3. Put account name also to .env +4. Add a channel for the bot to join +5. Program some logic +6. Build and test \ No newline at end of file