https://github.com/hubot-archive/hubot-tell
Hubot plugin to send a user a message the next time they are present in the room
https://github.com/hubot-archive/hubot-tell
Last synced: 2 months ago
JSON representation
Hubot plugin to send a user a message the next time they are present in the room
- Host: GitHub
- URL: https://github.com/hubot-archive/hubot-tell
- Owner: hubot-archive
- License: mit
- Created: 2014-08-30T23:49:33.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-12-18T20:00:36.000Z (over 9 years ago)
- Last Synced: 2025-04-01T20:12:39.020Z (3 months ago)
- Language: CoffeeScript
- Size: 32.2 KB
- Stars: 26
- Watchers: 4
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
hubot-tell
==========
Hubot plugin to send a user a message the next time they are present in the room
Installation
------------
Add **hubot-tell** to your `package.json` file:
```javascript
"dependencies": {
"hubot": ">= 2.5.1",
"hubot-tell": "*"
}
```
Add **hubot-tell** to your `external-scripts.json`:
```javascript
["hubot-tell"]
```
Run `npm install`
Usage
-----
Assuming your hubot instance is called `hubot`, you can instruct it to relay a message as follows:
`hubot: tell `
The message will then be stored and relayed to the recipient(s) as soon as they enter the room. You can specifiy a comma-separated list to send your message to multiple users.
Case-insensitive prefix matching is used to match the recipients' nicknames. That way, you can make sure that your message will reach its destination, even if the recipient has a different nickname suffix. If you send a message to `foo`, and `foo1` joins the room, the message will be delivered to them.
If your hubot has a persistent brain (e.g. with redis), messages will be preserved there even if you restart your life embetterment robot.
Configuration
-------------
By default, this script uses absolute timestamps to indicate when a message was sent. If you prefer relative timestamps of the form `2 hours ago` over absolute ones like `Mon Apr 21 2014 10:37:28 GMT+0200 (CEST)`, set the evironment variable `HUBOT_TELL_RELATIVE_TIME`.
Original Authors
----------------
Contributions to this script were made by [Chris Christensen](https://github.com/christianchristensen), [Fabio Cantoni](https://github.com/cover), [Uwe L. Korn](https://github.com/xhochy), [BFGeorge9000](https://github.com/BFGeorge9000), [Josh Nichols](https://github.com/technicalpickles), and [Lorenz Hübschle-Schneider](https://github.com/lorenzhs) before it was migrated to this repository. This information was lost during the migration process from the github/hubot-scripts repository, so they shall be listed here instead.