Skip to content

Commit 250cbe4

Browse files
authored
docs: simplify and clean cloudevent docs (#460)
Signed-off-by: Grant Timmerman <[email protected]>
1 parent aa58c87 commit 250cbe4

File tree

2 files changed

+3
-14
lines changed

2 files changed

+3
-14
lines changed

README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -241,18 +241,6 @@ functions.cloudEvent('helloCloudEvents', (cloudevent) => {
241241
});
242242
```
243243
244-
To enable the CloudEvent functions, you must list the Functions Framework as a dependency in your `package.json`:
245-
246-
```json
247-
{
248-
"dependencies": {
249-
"@google-cloud/functions-framework": "~2.0.0-beta.1"
250-
}
251-
}
252-
```
253-
254-
Learn how to use CloudEvents in this [guide](docs/cloudevents.md).
255-
256244
## Advanced Docs
257245
258246
More advanced guides and docs can be found in the [`docs/` folder](docs/).

docs/cloudevents.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This guide shows you how to use the Functions Framework for local testing with:
1010
Install `@google-cloud/functions-framework` and list it as a dependency in your `package.json`:
1111

1212
```
13-
npm install --save @google-cloud/functions-framework
13+
npm install @google-cloud/functions-framework
1414
```
1515

1616
Create an `index.js` file and declare your function:
@@ -48,7 +48,8 @@ npm start
4848
Your function will be serving at `http://localhost:8080/`, however,
4949
it is no longer accessible via `HTTP GET` requests from the browser.
5050

51-
### Create and send a cloudevent to the function
51+
### Create and Send a CloudEvent to the Function
52+
5253
```
5354
cloudevents send http://localhost:8080 --specver--id abc-123 --source cloudevents.conformance.tool --type foo.bar
5455
```

0 commit comments

Comments
 (0)