update cli docs

Author: Miguel Savignano

README.md

@@ -43,43 +43,39 @@ Docker Hub
     image_name: devmasx/project-name
 ```
 
+## Usage
+
 ## Docker build
 
 Use the latest docker image for use as cache
-Docker commands example:
 
 ```
-
 npx cached-docker-build-push --image-name image-name --image-tag v1
 
 ```
 
 Execute this docker commands:
 
 ```
-
 docker pull image-name || exit 0
 docker build --cache-from=image-name -t image-name -t image-name:v1
 docker push image-name:v1
 docker push image-name
-
 ```
 
 ## Docker build with multi stage
 
 With multi stage we need to save the builder stage for use as cache. Use the flag `--cache-stage-target` for define the builder stage
 
 ```
-
 npx cached-docker-build-push --cache-stage-target=builder --image-name image-name --image-tag v1
-
 ```
 
 Execute this docker commands:
 
 ```
+docker pull image-name:cache-builder || exit 0
 
-docker pull image-name:cache-builder
 docker build \
  --cache-from=image-name:cache-builder \
  --target builder \
@@ -95,9 +91,10 @@ docker build \
 docker push image-name:cache-builder
 docker push image-name:v1
 docker push image-name
-
 ```
 
-```
+### See more
 
 ```
+npx cached-docker-build-push --help
+```

action.yml

@@ -2,19 +2,19 @@ name: "cached-docker-build-push"
 description: "Action for docker build and push with cache"
 inputs:
   image_name:
-    description: "image_name"
+    description: "Image name, required"
     required: true
   image_tag:
-    description: "image_tag, default $GITHUB_SHA"
+    description: "Image tag, default $GITHUB_SHA"
     required: false
   cache_image_name:
-    description: "cache_image_name"
+    description: "Image name for the cache image, default $IMAGE_NAME:cache-$CACHE_STAGE_TARGET"
     required: false
   cache_stage_target:
-    description: "cache_stage_target"
+    description: "Name of the stage target for use in cache, two images will be compiled, the stage target and the last stage."
     required: false
   build_params:
-    description: "Add multiple docker build params, example: --build-arg Dockerfile"
+    description: "Add any docker build flag, --build-params='--build-arg=TOKEN=$TOKEN'"
     required: false
 runs:
   using: "node12"

bin/cached-docker-build-push.js

@@ -2,10 +2,25 @@
 const { dockerBuild } = require("../src/cached-docker-build-push");
 const argv = require("minimist")(process.argv.slice(2));
 
-if (argv.help) {
+if (argv.help || Object.keys(argv).length == 1) {
   return console.log(`
-  usage: [--image-name] [--image-tag] [--cache-image-name]
-         [--cache-stage-target] [--build-params]
+  usage: [--image-name] [--image-tag] [--build-params]
+         [--cache-stage-target] [--cache-image-name]
+
+      --image-name
+      Image name, required
+
+      --image-tag
+      Image tag, required
+
+      --build-params
+      Add any docker build flag, --build-params="--build-arg=TOKEN=$TOKEN"
+
+      --cache-stage-target
+      Name of the stage target for use in cache, two images will be compiled, the stage target and the last stage.
+
+      --cache-image-name
+      Image name for the cache image, default $IMAGE_NAME:cache-$CACHE_STAGE_TARGET
   `);
 }