ship-7-api-lib/readme.md

Biblioteca de funções para serem usadas nos projetos Ship7

<p align="center">
  <img src="https://cdn.shopify.com/s/files/1/0185/5092/products/nature-0006_large.png" width="200" alt="generator-bunny" />
</p>

<p align="center">
  <strong>
    Jumpstart <a href="https://nodejs.org/api/modules.html#modules_modules">node module</a>, like a bunny!
  </strong>
</p>

<p align="center">
  Scaffold <a href="https://www.npmjs.com/">node module</a> or <a href="https://en.wikipedia.org/wiki/Open-source_software">open-source</a> project without having to deal with complicated setup.
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/ship-7-api-lib">
    <img src="https://img.shields.io/npm/v/ship-7-api-lib.svg?style=flat-square" />
  </a>
  <a href="https://travis-ci.org/ship7software/ship-7-api-lib">
    <img src="https://img.shields.io/travis/ship7software/ship-7-api-lib/master.svg?style=flat-square" />
  </a>
  <a href="https://codecov.io/github/ship7software/ship-7-api-lib">
    <img src="https://img.shields.io/codecov/c/github/ship7software/ship-7-api-lib.svg?style=flat-square" />
  </a>
  <a href="https://david-dm.org/ship7software/ship-7-api-lib">
    <img src="https://david-dm.org/ship7software/ship-7-api-lib.svg?style=flat-square" />
  </a>
  <a href="https://github.com/prettier/prettier">
    <img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square" />
  </a>
  <a href="https://github.com/ship7software/ship-7-api-lib/blob/master/license">
    <img src="https://img.shields.io/github/license/ship7software/ship-7-api-lib.svg?style=flat-square" />
  </a>
  <br />
  <a href="https://github.com/semantic-release/semantic-release">
    <img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square" />
  </a>
  <a href="http://commitizen.github.io/cz-cli">
    <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square" />
  </a>
  <a href="http://makeapullrequest.com">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" />
  </a>
  <a href="https://github.com/ship7software/ship-7-api-lib/blob/master/other/code_of_conduct.md">
    <img src="https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square" />
  </a>
  <a href="https://github.com/ship7software/ship-7-api-lib/blob/master/other/roadmap.md">
    <img src="https://img.shields.io/badge/%F0%9F%93%94-roadmap-CD9523.svg?style=flat-square" />
  </a>
  <a href="https://github.com/ship7software/ship-7-api-lib/blob/master/other/examples.md">
    <img src="https://img.shields.io/badge/%F0%9F%92%A1-examples-8C8E93.svg?style=flat-square" />
  </a>
</p>

<br />


## Highlights


## Installation

```sh
# with yarn:
yarn add ship-7-api-lib

# or with npm: 
npm install --save ship-7-api-lib
```


## Usage

```js
import ship7ApiLib from 'ship-7-api-lib';

// do what you wanna do
console.log(ship7ApiLib);
```

## Suggestions

Help things to get better, contributions of any kind are welcome!

Please check [`roadmap.md`][roadmap-link] to list or see something you can contribute on, then [make a pull request][prs-link] of it!<br />
Also see [`contributing.md`](./contributing.md) for more informations about how to contribute.


## Contributors

This project follows the [all-contributors][all-contributors-link] specification.<br />
Thanks goes to these people:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
| [<img src="https://avatars2.githubusercontent.com/u/22868432?v=3" width="100px;"/><br /><sub>ship7software</sub>](http://ship7.com.br/)<br />[💻](https://github.com/ship7software/ship-7-api-lib/commits?author=ship7software "Code") [📖](https://github.com/ship7software/ship-7-api-lib/commits?author=ship7software "Documentation") [💡](#example-ship7software "Examples") |
| :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->


## Inspiration

Heavily inspired from [Sindre Sorhus][sindresorhus-link] & [Kent C. Dodds][kentcdodds-link].


## Useful links

-   [How to contribute to an open-source project](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
-   [Submitting a pull request (PR)](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-submitting-a-pull-request-pr)
-   [Thoughts on small module](https://github.com/sindresorhus/ama/issues/10#issuecomment-117766328)


## License

MIT &copy; [ship7software](http://ship7.com.br/)


[all-contributors-link]: https://github.com/kentcdodds/all-contributors
[kentcdodds-link]: https://github.com/kentcdodds
[prs-link]: http://makeapullrequest.com
[sindresorhus-link]: https://github.com/sindresorhus
[roadmap-link]: https://github.com/ship7software/ship-7-api-lib/blob/master/other/roadmap.md