git-push/README.md

Use git-push to deploy your website to Azure, Heroku, GitHub Pages or any another hosting provider supporting Git-based deployments.

# git-push [![Tips](http://img.shields.io/gratipay/koistya.svg?style=flat)](https://gratipay.com/koistya)

> Use [git-push](https://github.com/koistya/git-push) to deploy your website to
> [Azure](http://azure.microsoft.com/services/app-service/web/), [Heroku](https://www.heroku.com/),
> [GitHub Pages](https://pages.github.com/) or any other hosting provider
> supporting Git-based deployments.

## Install

[![NPM](https://nodei.co/npm/git-push.png?compact=true)](https://www.npmjs.org/package/git-push)

```sh
npm install git-push --save-dev
```

### Example 1

```js
// deploy.js

var push = require('get-push');

push('./app', 'http://github.com/example/example.github.io', function() {
  console.log('Done!');
});
```

```sh
$ node deploy.js
```

### Example 2

```js
// gulpfile.js

var gulp = require('gulp');
var push = require('get-push');
var argv = require('minimist')(process.argv.slice(2));

gulp.task('build', function() {
  // TODO: Build website from source files into the `./build` folder
});

gulp.task('deploy', function(cb) {
  var remote = argv.production ?
    {name: 'production', url: 'http://github.com/user/example.com', branch: 'gh-pages'},
    {name: 'test', url: 'http://github.com/user/test.example.com', branch: 'gh-pages'};
  push('./build', remote, cb);
});
```

```sh
$ gulp build --release
$ gulp deploy --production
```

## API

##### push(sourceDir, remote, callback);

## Reference

 - [Continuous deployment using Git in Azure App Service](http://azure.microsoft.com/documentation/articles/web-sites-publish-source-control/) by Windows Azure
 - [Kudu - the engine behind Git deployments in Azure Web Apps](https://github.com/projectkudu/kudu) by Windows Azure
 - [How To Set Up Automatic Deployment with Git with a VPS](https://www.digitalocean.com/community/tutorials/how-to-set-up-automatic-deployment-with-git-with-a-vps) by DigitalOcean
 - [Deploying with Git](https://devcenter.heroku.com/articles/git) by Heroku
 - [Git as a deployment tool](http://gitolite.com/deploy.html) by gitolite

## License

The MIT License (MIT) © Konstantin Tarkus ([@koistya](https://twitter.com/koistya))