codeship/README.md

An API wrapper of Codeship

# codeship-api
[![npm version](https://badge.fury.io/js/codeship.svg)](https://badge.fury.io/js/codeship)
[![Build Status](https://travis-ci.org/John-Lin/codeship-api.svg?branch=master)](https://travis-ci.org/John-Lin/codeship-api)

An better API wrapper for [Codeship](https://codeship.com/).

[Codeship API Docs](https://codeship.com/documentation/integrations/api/)

## Install

With [npm](https://www.npmjs.com/) do:

```sh
npm install codeship
```

## How do I get a API key?
After [sign up Codeship](https://codeship.com/registrations/new). You can get your API key on [your account page](https://codeship.com/user/edit).

## Example usage

```javascript
'use strict';
let Codeship = require('codeship');
let codeship = new Codeship('APIKEY');

codeship.listProjects((err, results) => {
  if (err) throw err;
  console.log(results);
});

codeship.getProject('111139', (err, result) => {
  if (err) throw err;
  console.log(result);
});

codeship.getProjectBuildData('111139', (err, result) => {
  if (err) throw err;
  console.log(result);
});

```

## APIs

### codeship.listProjects(cb)
Return an array include all projects on codeship.

### codeship.getProject(projectId, cb)
Return a single project `projectId` is required.

### codeship.getProjectBuildData(projectId, cb)
Return build data in a single project `projectId` is required.

## License
MIT © [Che-Wei Lin](https://github.com/John-Lin)