diff --git a/History.md b/History.md index 8052540..d1deea6 100644 --- a/History.md +++ b/History.md @@ -1,5 +1,9 @@ # Docker Version History +## 0.3.0 + + * Changed binary name to ´docker.js´ to mitigate naming conflict with docker CLI. + ## 0.2.14 * Improvements to handling of literals that shouldn't be matched for comments diff --git a/README.md b/README.md index 25e7f00..7442354 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Simple: `npm install -g docker` ## Usage ```sh -$ docker [options] [files ...] +$ docker.js [options] [files ...] ``` Available options are: @@ -47,21 +47,21 @@ If you haven't installed with `-g` specified, replace `docker` with something li ### Process every file in the current directory into "doc" ```sh -$ docker +$ docker.js ``` ### Process files in "src" to "documents" ```sh -$ docker -i src -o documents +$ docker.js -i src -o documents ``` or: ```sh -$ docker -o documents src +$ docker.js -o documents src ``` or: ```sh -$ docker -o documents src/* +$ docker.js -o documents src/* ``` Note that in the first example, the contents of `src` will be mapped directly into `documents` whereas in the second and third @@ -81,7 +81,7 @@ This is the command I use to generate [this project's documentation](http://jbt. * Include the File Search extra ```sh -$ docker -o ../docker_gh-pages -c manni -s yes -I -u -x node_modules -w --extras fileSearch +$ docker.js -o ../docker_gh-pages -c manni -s yes -I -u -x node_modules -w --extras fileSearch ``` ## Extras diff --git a/docker b/docker.js similarity index 100% rename from docker rename to docker.js diff --git a/package.json b/package.json index 235a570..747ad80 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "JT ", "name": "docker", - "version": "0.2.14", + "version": "0.3.0", "dependencies": { "mkdirp": "0.3.2", "commander": "0.5.2", @@ -9,7 +9,7 @@ "pygmentize-bundled": "~2.1.0" }, "bin": { - "docker": "./docker" + "docker.js": "./docker.js" }, "engines": { "node": ">=0.4.0"