Skip to content

Commit b460ab8

Browse files
jama22matthewrobertson
authored andcommitted
docs: Update README.md (GoogleCloudPlatform#658)
1 parent 28b1c30 commit b460ab8

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

README.md

+7-16
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
[![Node unit CI][ff_node_unit_img]][ff_node_unit_link] [![Node lint CI][ff_node_lint_img]][ff_node_lint_link] [![Node conformace CI][ff_node_conformance_img]][ff_node_conformance_link] ![Security Scorecard](https://api.securityscorecards.dev/projects/github.com/GoogleCloudPlatform/functions-framework-nodejs/badge)
66

77
An open source FaaS (Function as a Service) framework based on [Express](https://expressjs.com/)
8-
for writing portable Node.js functions -- brought to you by the Google Cloud Functions team.
8+
for writing portable Node.js functions.
99

1010
The Functions Framework lets you write lightweight functions that run in many
1111
different environments, including:
1212

13-
* [Google Cloud Functions](https://cloud.google.com/functions/)
13+
* [Google Cloud Run functions](https://cloud.google.com/functions/)
1414
* Your local development machine
1515
* [Cloud Run](https://cloud.google.com/run/) and [Cloud Run for Anthos](https://cloud.google.com/anthos/run)
1616
* [Knative](https://github.com/knative/)-based environments
@@ -156,25 +156,16 @@ command-line arguments:
156156

157157
## Run your function on serverless platforms
158158

159-
### Google Cloud Functions
159+
### Google Cloud Run functions
160160

161-
The
162-
[Node.js 10 runtime on Google Cloud Functions](https://cloud.google.com/functions/docs/concepts/nodejs-10-runtime)
163-
is based on the Functions Framework. On Cloud Functions, the Functions Framework
164-
is completely optional: if you don't add it to your `package.json`, it will be
165-
installed automatically.
161+
The [Node.JS runtime on Cloud Run functions](https://cloud.google.com/functions/docs/concepts/nodejs-runtime) utilizes the Node.JS Functions Framework. On Cloud Run functions, the Functions Framework is completely optional: if you don't add it to your `package.json`, it will be
162+
installed automatically. For
166163

167164
After you've written your function, you can simply deploy it from your local
168165
machine using the `gcloud` command-line tool.
169166
[Check out the Cloud Functions quickstart](https://cloud.google.com/functions/docs/quickstart).
170167
171-
### Cloud Run / Cloud Run for Anthos
172-
173-
After you've written your function, added the Functions Framework and updated your `start` script in `package.json`, deploy it to Cloud Run with `gcloud run deploy`. Check out the [Cloud Run quickstart for Node.js](https://cloud.google.com/run/docs/quickstarts/build-and-deploy/nodejs).
174-
175-
If you want even more control over the environment, you can [deploy to Cloud Run for Anthos](https://cloud.google.com/anthos/run/docs/quickstarts/prebuilt-deploy-gke). With Cloud Run for Anthos, you can run your function on a GKE cluster, which gives you additional control over the environment (including use of GPU-based instances, longer timeouts and more).
176-
177-
### Container environments based on Knative
168+
### Container environments based on KNative
178169
179170
Cloud Run and Cloud Run for Anthos both implement the [Knative Serving API](https://www.knative.dev/docs/). The Functions Framework is designed to be compatible with Knative environments. Just build and deploy your container to a Knative environment.
180171
@@ -201,7 +192,7 @@ For example:
201192
}
202193
```
203194
204-
## Enable Google Cloud Functions Events
195+
## Enable Google Cloud Run functions Events
205196
206197
The Functions Framework can unmarshall incoming
207198
Google Cloud Functions [event](https://cloud.google.com/functions/docs/concepts/events-triggers#events) payloads to `data` and `context` objects.

0 commit comments

Comments
 (0)