Skip to content

Commit 07fd55a

Browse files
authored
Update README.md
1 parent b952642 commit 07fd55a

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
# Lemmy RemindMe Bot
22
A lemmy bot that reminds you after an amount of time
33

4-
This bot is being hosted already at programming.dev! WARNING: Do not self host in an instance that federates as it will trigger on messages twice
4+
This bot is being hosted already at programming.dev! I have disabled the keyword functionality so bots dont double post. Please do not enable it
55

6-
This is just available due to AGPL and in case anyone wishes to contribute and should not be hosted manually
6+
This is still available if you want to self host but will need to be triggered off of mentions
77

8-
To trigger the bot just mention it at the start of the message. `Ex: @RemindMe@programming.dev remind me in 5 minutes` or use a keyword, !remindme or @remindme
8+
`Example: @RemindMe@programming.dev 5 years`
99

10+
## Setup
11+
1. Clone the repository
12+
2. Create an account in the instance you want the bot to have as its home (just make a regular user)
13+
3. Create a file called .env in the bot folder and give it values in this format with the data in the quotes (dont add the slashes or the part after the slashes)
14+
```
15+
LEMMY_INSTANCE="" // The instance the bot account is in
16+
LEMMY_USERNAME="" // The bot username
17+
LEMMY_PASSWORD="" // The bot password
18+
```
19+
4. Change the data in config.yaml based on what you want set
20+
5. Open a terminal in the bot folder and run `npm install` to install dependendies and then `node main.js` to run the bot (whenever you want to start the bot again you can just do ctrl+c to interrupt the process and node main.js to start the bot)
21+
22+
I recommend installing something like [forever.js](https://www.npmjs.com/package/forever) for making it run continually
23+
24+
If you run into issues feel free to dm me on Matrix [here](https://matrix.to/#/@ategon:matrix.org)

0 commit comments

Comments
 (0)