ts-foursquare/README.md

A simple library for Foursquare API

<h1 align="center">Welcome to ts-foursquare 👋</h1>

<p>A simple library for Foursquare API</p>

<p>
  <a href="https://www.npmjs.com/package/ts-foursquare" target="_blank">
    <img alt="Version" src="https://img.shields.io/npm/v/ts-foursquare.svg">
  </a>
  <img alt="Commit Activity" src="https://img.shields.io/github/commit-activity/m/arnaud-zg/ts-foursquare" />
  <a href="https://travis-ci.org/arnaud-zg/ts-foursquare" target="_blank">
    <img alt="Build Status" src="https://travis-ci.org/arnaud-zg/ts-foursquare.svg?branch=develop" />
  </a>
  <a href="https://bundlephobia.com/result?p=ts-foursquare" target="_blank">
    <img alt="Bundle Size" src="https://badgen.net/bundlephobia/min/ts-foursquare" />
  </a>
</p>

<p>
  <img alt="Issues Closed" src="https://img.shields.io/github/issues-closed/arnaud-zg/ts-foursquare">
  <img alt="Issues Open" src="https://img.shields.io/github/issues/arnaud-zg/ts-foursquare">
  <img alt="Pull Request Closed" src="https://img.shields.io/github/issues-pr-closed/arnaud-zg/ts-foursquare">
  <img alt="Pull Request Open" src="https://img.shields.io/github/issues-pr/arnaud-zg/ts-foursquare">
</p>

### Installing

Using npm:

```shell
npm i --save ts-foursquare
```

Using yarn:

```shell
yarn add --dev ts-foursquare
```

## Documentation

Look at the documentation

- [Usage](./docs/usage.md)

## Running the tests

Tests are written with jest

### Unit tests

Using jest:

```shell
yarn run test
```

## Built With

- [TSDX](https://github.com/palmerhq/tsdx) - TSDX

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) 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/arnaud-zg/ts-foursquare/tags).

## Authors

- **Arnaud Zheng** - _Initial work_ - [arnaud-zg](https://github.com/arnaud-zg)

See also the list of [contributors](https://github.com/arnaud-zg/ts-foursquare/graphs/contributors) who participated in this project.

## Show your support

Give a ⭐️ if this project helped you!

## License

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