README
cta-node
Project Name
Chicago Transit Authority - Bus and Train Tracker - Node JS module
Special Note
First node project. All feedback is appreciated This package will change drastically over the next couple of releases.
Installation
TODO: Describe the installation process
Usage
var cta = require("cta-node");
// Set environment variables
// CTA_TRAIN_API_KEY=abc...
// CTA_BUS_API_KEY=123...
cta.init()
// or pass in as a dictionary
cta.init({ trainApiKey: "abc...", busApiKey: "123..."});
cta.train.lStops.byStationName('wilson');
// array of stops
cta.train.lStops.byStationNameAndColor('western', 'blue');
// array of stops
cta.train.arrivals.byStationNameAndColor('western', 'blue');
// array of arrivals
// Look ma, no color...
// NOTE: this is going to change
cta.train.arrivals.byStationNameAndColor('sheridan');
// array of arrivals
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
History
TODO: Write history
Credits
TODO: Write credits
License
TODO: Write license