# gitter

> GitHub client (API v3)

Latest version **0.2.0** (published 2012-06-13) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install gitter
pnpm add gitter
yarn add gitter
bun add gitter
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2012-06-13 |
| First published | 2011-01-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.6.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | Sami Samhuri |
| Maintainers | sjs |

## Links

- npm: https://www.npmjs.com/package/gitter
- Repository: https://github.com/samsonjs/gitter
- Homepage: http://samhuri.net/proj/gitter
- Issues: http://github.com/samsonjs/gitter/issues
- npm.io page: https://npm.io/package/gitter

## Recent versions

- 0.2.0 (latest) — 2012-06-13
- 0.1.2 — 2011-01-04
- 0.0.1 — 2011-01-04
- 0.0.2 — 2011-01-04
- 0.0.3 — 2011-01-04
- 0.1.0 — 2011-01-04
- 0.1.1 — 2011-01-04

## README

gitter
======

A GitHub client inspired by [pengwynn/octokit](https://github.com/pengwynn/octokit).

v3 API

Works in Node.js and most web browsers.


Installation
============

npm install gitter


Usage
=====

    var gh = require('gitter')
    gh.user('samsonjs', function(err, user) {
      if (err) throw err
      console.log('---- user: samsonjs ----')
      console.dir(user)
    })

    gh.repo('samsonjs', 'gitter', function(err, repo) {
      if (err) throw err
      console.log('---- repo: ' + repo.owner + '/' + repo.name + ' ----')
      console.dir(repo)
    }).fetchWatchers(function(err, watchers) {
      if (err) throw err
      console.log('---- watchers ----')
      console.dir(watchers)
    }).fetchBranches(function(err, branches) {
      if (err) throw err
      console.log('---- branches: samsonjs/gitter ----')
      console.dir(branches)
      gh.commit(this.user, this.repo, branches['master'], function(err, commit) {
        if (err) throw err
        console.log('---- samsonjs/gitter/master commit: ' + commit.id + ' ----')
        console.dir(commit.data())
      })
    })

For the full API have a look at the top of [lib/index.js](https://github.com/samsonjs/gitter/blob/master/lib/index.js).


License
=======

Copyright 2010 - 2012 Sami Samhuri sami@samhuri.net

[MIT License](http://sjs.mit-license.org)

---
_Source: https://npm.io/package/gitter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._