captaindash/node-mention-api

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# node-mention-api [![NPM version][npm-img]][npm]

[![Build Status][travis-img]][travis]
[![Test Coverage][codeclimate-coverage-img]][codeclimate]
[![Code Climate][codeclimate-gpa-img]][codeclimate]
[![Dependencies Status][daviddm-dep-img]][daviddm-dep]

A Node.js client to query the [Mention API][mention-api].

## Installation

```bash
npm install mention-api
```

## Changelog

- 1.2.0
  * Upgrading outdated packages

- 1.1.0
  * Updating Joi version

- 1.0.0
  * Bump stable

- 0.1.0
  * All endpoints implemented

## Authors

See [`package.json`](./package.json)

## License

See [`UNLICENSE`](./UNLICENSE)

## Contributing

- Please comment your code with [JSDoc][jsdoc]
- Please keep 100% [unit tests coverage](./test/unit)
- Please follow the [Angular commit guidelines][angular-commit-guidelines]

[npm]: https://www.npmjs.org/package/mention-api
[travis]: https://travis-ci.org/captaindash/node-mention-api
[codeclimate]: https://codeclimate.com/github/captaindash/node-mention-api
[daviddm-dep]: https://david-dm.org/captaindash/node-mention-api

[npm-img]: http://img.shields.io/npm/v/mention-api.svg?style=flat
[travis-img]: http://img.shields.io/travis/captaindash/node-mention-api/master.svg?style=flat
[codeclimate-coverage-img]: http://img.shields.io/codeclimate/coverage/github/captaindash/node-mention-api.svg?style=flat
[codeclimate-gpa-img]: http://img.shields.io/codeclimate/github/captaindash/node-mention-api.svg?style=flat
[daviddm-dep-img]: http://img.shields.io/david/captaindash/node-mention-api.svg?style=flat

[angular-commit-guidelines]: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit
[jsdoc]: http://usejsdoc.org/
[mention-api]: https://dev.mention.com