Editing Packaging jQuery Plugins (section)

== Distribution ==

=== Marking a release ===

See [[Marking Releases With Git]]

=== Specifying files to install with `npm` ===

Use the `.npmignore` file in the root of plugin project to specify which files to exclude when running `npm install`. `.npmignore` works the same way as `.gitignore`. <ref>[https://docs.npmjs.com/files/package.json#files `files` setting in `package.json` documentation], `npm` documentation</ref>

=== Publishing npm packages ===

I'm actually more interested in distributing packages through GitHub since they are mostly for use in my own projects. 

* [http://blog.npmjs.org/post/111475741445/publishing-your-jquery-plugin-to-npm-the-quick Publishing your jQuery plugin to npm, the quick and dirty way], `npm` Blog

=== Using plugins in projects ===

Use `npm` to fetch the plugin from GitHub, included in in the project, and add it to the project requirements:

<syntaxhighlight lang="bash">
$ npm install git+https://git@github.com/northrose/lightboxLink.git --save
</syntaxhighlight>

* The `--save` parameter updates `package.json`, adding the package as a dependency of the project. 
* To use a branch other than `master` append `#branchname` to the repo URL.


* [http://blog.npmjs.org/post/112064849860/using-jquery-plugins-with-npm Using jQuery plugins with npm], `npm` Blog