An open API service indexing awesome lists of open source software.

https://github.com/hubot-archive/hubot-ttc-alerts


https://github.com/hubot-archive/hubot-ttc-alerts

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# Hubot TTC transit alerts

hubot script to display TTC (Toronto transit) alerts

## Installation

### Update the files to include the hubot-ttc-alerts module:

#### package.json
...
"dependencies": {
...
"hubot-ttc-alerts": ">= 1.0.0"
...
},
...

#### external-scripts.json
[...,"hubot-ttc-alerts"]

Run `npm install` to install hubot-ttc-alerts and dependencies.

## Commands

```javascript
hubot ttc me
```

## Directory Structure

Using the common directory structure for hubot script packages it will be easy
to manage and allow others to easily contribute to your package.

### script

This directory is home to a couple of development scripts; `bootstrap` and `test`
they're used to bootstrap the development environment and run tests
respectively.

### src

This directory is home to the actual hubot scripts in the package. Your
`index.coffee` entry point will load the scripts from this directory.

### test

This directory is home to any tests you write for your scripts. This example
package uses Mocha, Chai and Sinon to manage writing tests.