assemble-contrib-download

Assemble plugin for downloading files from GitHub.

npm install assemble-contrib-download
15 downloads in the last week
22 downloads in the last month

assemble-contrib-download NPM version

Assemble plugin for downloading files from GitHub.

Quickstart

In the command line, run:

npm install assemble-contrib-download --save

Next, to register the plugin with Assemble in your project's Gruntfile you can either specify the direct path to the plugin(s) (e.g. ./path/to/plugins/*.js), or if installed via npm, make sure the plugin is in the devDependencies of your project.js package.json, and simply add the module's name to the plugins option:

assemble: {
  options: {
    plugins: ['assemble-contrib-download', 'other/plugins/*.js']
  }
}

Visit the plugins docs for more info or for help getting started.

Options

repo

Type: String Default: assemble/handlebars-helpers

Repo from which to download files.

dest

Type: String Default: tmp/

Destination for the downloaded files.

files

Type: Array Default: ['docs/helpers.zip']

Paths the file or files to download.

Usage Examples

assemble: {
  options: {
    plugins: ['assemble-contrib-download'],
    download: {
      repo: 'assemble/handlebars-helpers',
      files: ['docs/helpers.zip'],
      dest: 'tmp/'
    }
  }
}

Contributing

Find a bug? Have a feature request? Please create an Issue. Pull requests are also encouraged. If you find this project useful, please consider "starring" it to show your support! Thanks!

Assemble plugins

Here are some related projects you might be interested in from the Assemble core team.

Authors

Jon Schlinkert

Brian Woodward

License

Copyright (c) 2014 Jon Schlinkert, contributors. Released under the MIT license


This file was generated by grunt-readme on Friday, February 14, 2014.

npm loves you