From 6a02eeb05fa8b4c437a9972a9d8fc5f58f8418aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lera=20Elvo=C3=A9?= Date: Mon, 24 Jul 2023 18:28:31 +0300 Subject: [PATCH] add more up to date info to readme --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e81a678..5dedaef 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# potomark is a simple bookmarking discord bot. +# potomark is a simple bookmarking and pinning discord bot. there's no configuration besides a `.env` file with two keys: - the bot's token `DISCORD_TOKEN`, @@ -8,7 +8,9 @@ there's no configuration besides a `.env` file with two keys: because we needed a tiny, self hostable bot to remember things of importance for our equally tiny discord server. ## what it do? -DMs a user a link to any message they reacte with 🔖 to (tip: you can change the `EMOJI` constant in `bot.rb` to any built-in emoji). also sends part of the message for quick access. that's it. +- DMs a user a link to any message they react with 🔖 to (tip: you can change the `BOOKMARK_EMOJI` constant in `bot.rb` to any built-in emoji). this also sends part of the message for quick access, +- lets users pin messages to the channel by reacting with 📌 on that message (change `PIN_EMOJI` to change the emoji). if there are no more of that emoji reactions on the message, it gets unpinned. +- lets users make sentences one word (or more) at a time in `SENTENCE_CHANNEL`. to finish a sentence, send either of these as a message: `?`, `!`, `.`, `...`, `?!` ## how? requires [ruby](https://www.ruby-lang.org/) >= 3.0 and [bundler](https://bundler.io) >= 2.3.19. the only two dependencies are `dotenv` and `discordrb`, as specified in the `Gemfile`.