diff --git a/examples/blog/functions.yml b/examples/blog/func.yml similarity index 100% rename from examples/blog/functions.yml rename to examples/blog/func.yml diff --git a/examples/caddy-lb/functions.yml b/examples/caddy-lb/func.yml similarity index 100% rename from examples/caddy-lb/functions.yml rename to examples/caddy-lb/func.yml diff --git a/examples/checker/functions.yml b/examples/checker/func.yml similarity index 100% rename from examples/checker/functions.yml rename to examples/checker/func.yml diff --git a/examples/echo/functions.yml b/examples/echo/func.yml similarity index 100% rename from examples/echo/functions.yml rename to examples/echo/func.yml diff --git a/examples/error/functions.yml b/examples/error/func.yml similarity index 100% rename from examples/error/functions.yml rename to examples/error/func.yml diff --git a/examples/hello-go/functions.yml b/examples/hello-go/func.yml similarity index 100% rename from examples/hello-go/functions.yml rename to examples/hello-go/func.yml diff --git a/examples/hello-ruby/functions.yml b/examples/hello-ruby/func.yml similarity index 100% rename from examples/hello-ruby/functions.yml rename to examples/hello-ruby/func.yml diff --git a/examples/hello/php/functions.yaml b/examples/hello/php/func.yaml similarity index 100% rename from examples/hello/php/functions.yaml rename to examples/hello/php/func.yaml diff --git a/examples/hello/python/functions.yaml b/examples/hello/python/func.yaml similarity index 100% rename from examples/hello/python/functions.yaml rename to examples/hello/python/func.yaml diff --git a/examples/redis/functions.yml b/examples/redis/func.yml similarity index 100% rename from examples/redis/functions.yml rename to examples/redis/func.yml diff --git a/examples/sleeper/functions.yml b/examples/sleeper/func.yml similarity index 100% rename from examples/sleeper/functions.yml rename to examples/sleeper/func.yml diff --git a/examples/twitter/functions.yml b/examples/twitter/func.yml similarity index 100% rename from examples/twitter/functions.yml rename to examples/twitter/func.yml diff --git a/fnctl/README.md b/fnctl/README.md index 453cc0eb7..3a7a4bf0f 100644 --- a/fnctl/README.md +++ b/fnctl/README.md @@ -10,10 +10,10 @@ Init will help you create a [function file](../docs/function-file.md) (func.yaml fnctl init [--runtime node] [--entrypoint "node hello.js"] ``` -`--runtime` and `--entrypoint` are optional, init will try to figure out it out based on the files in the current directory. -If it can't figure it out, it will tell you. +`--runtime` and `--entrypoint` are optional, init will try to figure out it out based on the files in the current directory. +If it can't figure it out, it will tell you. -If there's a Dockerfile found, it will use that as is +If there's a Dockerfile found, it will use that as is ### Build, Bump, Run, Push @@ -35,13 +35,13 @@ Run will help you test your function. Functions read input from STDIN, so you ca ```sh cat `payload.json` | fnctl run -``` +``` -Push will push the function image to Docker Hub. +Push will push the function image to Docker Hub. ```sh fnctl push -``` +``` ## Using the API @@ -175,7 +175,7 @@ It means that first subdirectory are always considered app names (e.g. `myapp` and `other`), each subdirectory of these firsts are considered part of the route (e.g. `route1/subroute1`). -`fnctl update` expects that each directory to contain a file `func.yaml` +`fnctl publish` expects that each directory to contain a file `func.yaml` which instructs `fnctl` on how to act with that particular update, and a Dockerfile which it is going to use to build the image and push to Docker Hub.