mud/potomark-bot-rb
1
0
Fork 0
forked from yagich/potomark-bot-rb
Code Issues Pull Requests Projects Releases Wiki Activity

add more up to date info to readme

Browse Source
This commit is contained in:
Lera Elvoé
2023-07-24 18:28:31 +03:00
parent 61e8ff8b34
commit 6a02eeb05f
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -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`.