### 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
