gulp-github-release/README.md

# gulp-github-release

Create GitHub releases with assets.

## Installation

```
npm install --save-dev gulp-github-release
```

## Usage

```js
var release = require('gulp-github-release');

gulp.task('release', function(){
  gulp.src('./dist/some-file.exe')
    .pipe(release({
      token: 'token',                     // or you can set an env var called GITHUB_TOKEN instead
      owner: 'remixz',                    // if missing, it will be extracted from manifest (the repository.url field)
      repo: 'publish-release',            // if missing, it will be extracted from manifest (the repository.url field)
      tag: 'v1.0.0',                      // if missing, the version will be extracted from manifest and prepended by a 'v'
      name: 'publish-release v1.0.0',     // if missing, it will be the same as the tag
      notes: 'very good!',                // if missing it will be left undefined
      draft: false,                       // if missing it's false
      prerelease: false,                  // if missing it's false
      manifest: require('./package.json') // package.json from which default values will be extracted if they're missing
    }));
});
```

## License

The MIT License (MIT)

Copyright (c) 2015 Alexandru Rosianu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.