node-groupme/README.md

The only GroupMe API library that isn't a million years old.

# node-groupme

| ✔️ This package is in active development! If you'd like to contribute, [click here](https://github.com/groupme-js/node-groupme/contribute) 🙂 |
| ----------------------------------------------------------------------------------------------------------------------------------------------- |

### About

Inspired by [discord.js](https://github.com/discordjs/discord.js), `node-groupme` aims to replace the obsolete [groupme](https://www.npmjs.com/package/groupme) package with a modern, object-oriented, intuitive approach to interacting with the GroupMe API.

<br>

[![npm](https://img.shields.io/npm/v/node-groupme?style=for-the-badge)](https://npmjs.com/node-groupme)
[![npm](https://img.shields.io/npm/v/node-groupme?color=red&label=Docs%20version&style=for-the-badge)](https://groupme.js.org)
[![Discord](https://img.shields.io/discord/898587555249946664?color=blue&label=Discord&style=for-the-badge)](https://discord.gg/5yxWtuuEZg)
<br><br>

---

This community-led effort is made possible by the [unofficial GroupMe API Community Docs](https://github.com/2CATteam/GroupMeCommunityDocs). Please contribute to the development of open-source applications by contributing to the community docs.

Join the [node-groupme server on Discord](https://discord.gg/5yxWtuuEZg) to discuss the API or ask any questions.

--- 

### Getting Started
```
npm i node-groupme
```
```js
const GroupMe = require('node-groupme');
const client = new GroupMe.Client('YOUR_TOKEN_HERE');

client.login()
    .then(client => client.groups.fetch())
    .then(groups => groups.forEach(group => console.log(group.name)))
    .then(client.logout)
    .catch(console.error);
```

---

### Getting Started (Contributing)
```
git clone git@github.com:groupme-js/node-groupme.git
npm i
npm run prepare
```
`npm run prepare` sets up [husky](https://github.com/typicode/husky) pre-commit hooks, which will auto format and run eslint on your staged files locally.