https://github.com/croz-ltd/rocket.chat.app-remind
https://github.com/croz-ltd/rocket.chat.app-remind
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/croz-ltd/rocket.chat.app-remind
- Owner: croz-ltd
- Created: 2019-01-19T20:07:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T22:00:06.000Z (almost 3 years ago)
- Last Synced: 2025-04-06T23:11:22.170Z (6 months ago)
- Language: JavaScript
- Size: 422 KB
- Stars: 13
- Watchers: 6
- Forks: 4
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rocket.Chat App - Remind Me
Slack inspired application to remind people.
Usage: /remind [me or @someone or #channel] [what] [when]
### Example
Triggering following reminder:
```
/remind me to go out and take long walk in 10 minutes
```
Post as user will send you acknowledge message that reminder is received and scheduled.
```
rocket.cat: 👍 I will remind you to "to go out and take long walk" in "10 seconds".
```
Or if you scheduled reminder for other person:
```
/remind @anotheruser to go out and take long walk in 10 minutes
```
```
rocket.cat: 👍 I will remind @anotheruser to "to go out and take long walk" in "15 seconds".
```
At the time reminder is triggered, you or targeted user will receive following message:
```
rocket.cat: You asked me to remind you to "to go out and take long walk".
```
### Time Formating
As Rocket.Chat implemented Scheduler API is using [agenda.js](https://github.com/agenda/agenda),
time formatting rules for reminders are defined by agenda.js.
### Configuration
On application configuration it is possible to change following settings:
- **Post as**
Choose the username that this integration will post as. The user must already exist.
Default: `rocket.cat`
Required: `true`
- **Alias**
Choose the alias that will appear before the username in messages.
Default: `\`
Required: `false`
## TODO
- [ ] Implementation of recurring reminders