Skip to content

Commit 0f0caac

Browse files
committed
Update intro
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent e86c575 commit 0f0caac

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
## faas-cli
2+
23
[![Build Status](https://github.com/openfaas/faas-cli/workflows/build/badge.svg?branch=master)](https://github.com/openfaas/faas-cli/actions)
34
[![Go Report Card](https://goreportcard.com/badge/github.com/openfaas/faas-cli)](https://goreportcard.com/report/github.com/openfaas/faas-cli)
45
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
56
[![OpenFaaS](https://img.shields.io/badge/openfaas-serverless-blue.svg)](https://www.openfaas.com)
67

7-
This is a CLI for use with [OpenFaaS](https://github.com/openfaas/faas) - a serverless functions framework for Docker & Kubernetes.
8-
9-
> Before using this tool please setup OpenFaaS by following instructions over on the main repo.
8+
faas-cli is the official CLI for [OpenFaaS](https://github.com/openfaas/faas)
109

1110
The CLI can be used to build and deploy functions to [OpenFaaS](https://github.com/openfaas/faas). You can build OpenFaaS functions from a set of supported language templates (such as Node.js, Python, CSharp and Ruby). That means you just write a handler file such as (handler.py/handler.js) and the CLI does the rest to create a Docker image.
1211

13-
Demo: [ASCII cinema](https://asciinema.org/a/141284)
14-
15-
### TL;DR - Introductory tutorial
16-
17-
[Blog: Coffee with the FaaS-CLI](https://blog.alexellis.io/quickstart-openfaas-cli/)
12+
New user? See how it works: [Morning coffee with the faas-cli](https://blog.alexellis.io/quickstart-openfaas-cli/)
13+
Already an OpenFaaS user? Try [5 tips and tricks for the OpenFaaS CLI](https://www.openfaas.com/blog/five-cli-tips/)
1814

1915
### Get started: Install the CLI
2016

@@ -245,13 +241,18 @@ Specify `lang: Dockerfile` if you want the faas-cli to execute a build or `skip_
245241
Read the blog post/tutorial: [Turn Any CLI into a Function with OpenFaaS](https://blog.alexellis.io/cli-functions-with-openfaas/)
246242

247243
#### `faas-cli registry-login`
244+
248245
This command allows to generate the registry auth file in the correct format in the location `./credentials/config.json`
246+
249247
#### Prepare your Docker registry (if not using AWS ECR)
248+
250249
If you are using Dockerhub you only need to supply your --username and --password-stdin (or --password, but this leaves the password in history).
251-
```
250+
251+
```bash
252252
faas-cli registry-login --username <your-registry-username> --password-stdin
253253
(then enter your password and use ctrl+d to finish input)
254254
```
255+
255256
You could also have you password in a file, or environment variable and echo/cat this instead of entering interactively
256257
If you are using a different registry (that is not ECR) then also provide a `--server` as well.
257258

@@ -374,7 +375,7 @@ $ kubeseal --fetch-cert --controller-name ofc-sealedsecrets-sealed-secrets > pub
374375

375376
Then seal a secret using the OpenFaaS CLI:
376377

377-
```
378+
```bash
378379
$ faas-cli cloud seal --name alexellis-github \
379380
--literal hmac-secret=1234 --cert=pub-cert.pem
380381
```
@@ -393,7 +394,7 @@ The [scripts/export-sealed-secret-pubcert.sh](https://github.com/openfaas-incuba
393394
* `OPENFAAS_CONFIG` - to override the location of the configuration folder, which contains auth configuration.
394395
* `CI` - to override the location of the configuration folder, when true, the configuration folder is `.openfaas` in the current working directory. This value is ignored if `OPENFAAS_CONFIG` is set.
395396

396-
### FaaS-CLI Developers / Contributors
397+
### Contributing
397398

398399
See [contributing guide](https://github.com/openfaas/faas-cli/blob/master/CONTRIBUTING.md).
399400

0 commit comments

Comments
 (0)