# hubot-simple-phonebook

> Query Hubot brain for user's contact information

Latest version **0.1.0** (published 2015-02-01) · 0 weekly downloads

## Install

```sh
npm install hubot-simple-phonebook
pnpm add hubot-simple-phonebook
yarn add hubot-simple-phonebook
bun add hubot-simple-phonebook
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-02-01 |
| First published | 2015-02-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ando Roots |
| Maintainers | anroots |
| Keywords | phonebook, hubot |

## Links

- npm: https://www.npmjs.com/package/hubot-simple-phonebook
- Repository: https://github.com/anroots/hubot-simple-phonebook
- Issues: https://github.com/anroots/hubot-simple-phonebook/issues
- npm.io page: https://npm.io/package/hubot-simple-phonebook

## Recent versions

- 0.1.0 (latest) — 2015-02-01

## README

# hubot-simple-phonebook

Query [Hubot](https://github.com/github/hubot) brain for user's contact information.

[![Downloads](https://img.shields.io/npm/dm/hubot-simple-phonebook.svg)](https://www.npmjs.com/package/hubot-simple-phonebook)
[![Version](https://img.shields.io/npm/v/hubot-simple-phonebook.svg)](https://github.com/anroots/hubot-simple-phonebook/releases)
[![Licence](https://img.shields.io/npm/l/express.svg)](https://github.com/anroots/hubot-simple-phonebook/blob/master/LICENSE)

This is a simple phonebook script for querying user contact information from the robot brain. You can set this
manually with the `phonebook set` command, have it auto-populated by your adapter (the [hubot-fleep](https://github.com/anroots/hubot-fleep)
adapter supports this) or import via a custom script directly into Redis.

![Example interaction](doc/img/screenshot.png)

Currently, the following user attributes are understood by the script:

- Email (`user.email`)
- Phone (`user.phone`)

## Installation

In your Hubot project directory, run:

```bash
npm install hubot-simple-phonebook --save
```

Enable the script by adding **hubot-simple-phonebook** to your `external-scripts.json`:

```json
[
  "hubot-simple-phonebook"
]
```
## Commands

* _hubot phonebook me &lt;name&gt;_ - Get contact information for &lt;name&gt;
* _hubot phonebook set (email|phone) of &lt;name&gt; to &lt;value&gt;_ - Saves the email or phone of the specified user

## Example Usage

Get contact information for a user called "David":

```
Hubot phonebook me David
```

Save the phone of an user called "Rose Tyler":

```
Hubot phonebook set phone of Rose Tyler to +4413294574
```

## Contributing

Pull requests and issue reports are welcome.

## Licence

The MIT License (MIT). Please see LICENCE file for more information.

---
_Source: https://npm.io/package/hubot-simple-phonebook · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
