gbfs/README.md

General Bikeshare Feed Specification implementation

# gbfs

`gbfs` is a Node.js library for querying a bikeshare source that adheres to the General Bikeshare Feed Specification (GBFS),
standardized by North American Bikeshare Association (NABSA).

- [What is GBFS?](https://github.com/NABSA/gbfs)
- [GBFS Official spec](https://github.com/NABSA/gbfs/blob/master/gbfs.md)
- [NABSA website](http://nabsa.net/)

This library replaces part of the functionality of the now-deprecated/obsolete `bcycle` library
[GitHub](https://github.com/chbrown/bcycle) /
[npm](https://www.npmjs.com/package/bcycle).


## Installation

Install from [npm](https://www.npmjs.com/package/gbfs):

    npm install --save gbfs


### Alternatives:

* `gbfs-client`: Node GBFS Client (CitiBike and others)

  [GitHub](https://github.com/mnkhouri/node-gbfs-client) /
  [npm](https://www.npmjs.com/package/gbfs-client)
* `wiki-plugin-bikeshare`: "Federated Wiki - Bikeshare Plugin"

  [GitHub](https://github.com/wardcunningham/wiki-plugin-bikeshare) /
  [npm](https://www.npmjs.com/package/wiki-plugin-bikeshare) /
  [docs](http://ward.asia.wiki.org/about-bikeshare-plugin.html)


## License

Copyright 2018 Christopher Brown.
[MIT Licensed](https://chbrown.github.io/licenses/MIT/#2018).