@abbott-platform/abbott-framework/README.md

Abbott Framework is a framework to bring productivity and abstractions to help you to build awesome chatbots.

# Abbott Framework

Abbott Framework is a framework to bring productivity and abstractions to help you to build awesome chatbots.

[![Waffle.io - Columns and their card count](https://badge.waffle.io/AbbottPlatform/abbott-framework.png?columns=all)](https://waffle.io/AbbottPlatform/abbott-framework?utm_source=badge)

[![Build Status][travis-image]][travis-url]
[![Coverage percentage][coveralls-image]][coveralls-url]
[![bitHound Overall Score](https://www.bithound.io/github/AbbottPlatform/abbott-framework/badges/score.svg)](https://www.bithound.io/github/AbbottPlatform/abbott-framework)

[![NPM version][npm-image]][npm-url]
[![dependencies Status][daviddm-image]][daviddm-url]
[![devDependencies Status][daviddm-dev-image]][daviddm-dev-url]

[GitBook](https://abbott-platform.gitbooks.io/abbott-framework/content/)

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

* [NodeJS >= 7.10.1](https://nodejs.org)

### Installing

A step by step series of examples that tell you have to get a development env running

Say what the step will be

```bash
$ npm install @abbott-platform/abbott-framework --save
```
OR
```bash
$ yarn add @abbott-platform/abbott-framework
```

End with an example of getting some data out of the system or using it for a little demo

## Running the tests

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

```
SOON!
```

### And coding style tests

Explain what these tests test and why

```
SOON!
```

## Deployment

SOON!

## Built With

* [Customized Version of Botkit](https://github.com/AbbottPlatform/botkit) - Building Blocks for Building Bots

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/AbbottPlatform/abbott-framework/tags). 

## Authors

* **Vinicius Patrinhani** - *Initial work* - [Patrinhani](https://github.com/patrinhani-ciandt)

See also the list of [contributors](https://github.com/AbbottPlatform/abbott-framework/contributors) who participated in this project.

*This project is suppported and encouraged by CI&T - http://www.ciandt.com*

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* Inspired by [Botkit](https://github.com/howdyai/botkit)

## References

JSDoc + GitBook Integration: https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3

[npm-image]: https://badge.fury.io/js/%40abbott-platform%2Fabbott-framework.svg
[npm-url]: https://npmjs.org/package/@abbott-platform/abbott-framework
[travis-image]: https://travis-ci.org/AbbottPlatform/abbott-framework.svg?branch=master
[travis-url]: https://travis-ci.org/AbbottPlatform/abbott-framework
[daviddm-image]: https://david-dm.org/AbbottPlatform/abbott-framework.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/AbbottPlatform/abbott-framework
[daviddm-dev-image]: https://david-dm.org/AbbottPlatform/abbott-framework/dev-status.svg
[daviddm-dev-url]: https://david-dm.org/AbbottPlatform/abbott-framework?type=dev
[coveralls-image]: https://coveralls.io/repos/github/AbbottPlatform/abbott-framework/badge.svg
[coveralls-url]: https://coveralls.io/github/AbbottPlatform/abbott-framework