buildbranch - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "buildbranch",
   "description": "Publish a folder to the given build branch (like gh-pages).",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "homepage": "https://github.com/nfroidure/buildbranch",
@@ -10,2 +10,5 @@ "author": {
   },
+  "bin": {
+    "buildbranch": "./src/bin.js"
+  },
   "repository": {
@@ -12,0 +15,0 @@ "type": "git",

README.md

@@ -6,6 +6,24 @@ # buildbranch
 
+You can use this from the command-line or within your build system.
+
+### Command-line
+
+First, install `buildbranch` globally:
+
+```shell
+npm install buildbranch -g
+```
+
+Then, from your master branch, run `buildbranch` with the branch and directory you want to publish. It will default to `gh-pages` and `www`.
+
+```shell
+buildbranch gh-pages www
+```
+
+### Build System
+
 First, install `buildbranch` as a development dependency:
 
 ```shell
-npm install --save buildbranch
+npm install buildbranch --save-dev
 ```
@@ -29,2 +47,13 @@
 
+For example in gulp you can do it like this:
+
+```javascript
+var gulp = require('gulp');
+var buildBranch = require('buildbranch');
+
+gulp.task('gh', ['build'], function(done) {
+  buildBranch({ folder: 'dist' }, done);
+});
+```
+
 ## API
@@ -89,2 +118,1 @@
  accept to publish under the MIT licence.
-

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7102

increased by15.35%

Number of package files

6

increased by50%

Lines of code

92

increased by17.95%

Number of lines in readme file

116

increased by31.82%

No dependency changes