docs: improve for CloudEvents (#475)

GoogleCloudPlatform · Dec 16, 2024 · bab6e2f · bab6e2f
1 parent f607b54
commit bab6e2f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -3,6 +3,7 @@
 This directory contains advanced docs around the Functions Framework.
 
 - [Testing events and Pub/Sub](events.md)
+- [Testing CloudEvents](cloudevents.md)
 - [Testing Functions](testing-functions.md)
 - [Debugging Functions](debugging.md)
 - [Running and Deploying Docker Containers](docker.md)

diff --git a/docs/cloudevents.md b/docs/cloudevents.md
@@ -34,7 +34,7 @@ Add a `package.json` script to start the Functions Framework and pass the name o
 ```sh
 {
   "scripts": {
-    "start": "functions-framework --target=helloCloudEvents"
+    "start": "functions-framework --target=helloCloudEvents --signature-type=cloudevent"
   }
 }
 ```
@@ -51,5 +51,5 @@ it is no longer accessible via `HTTP GET` requests from the browser.
 ### Create and Send a CloudEvent to the Function
 
 ```
-cloudevents send http://localhost:8080 --specver--id abc-123 --source cloudevents.conformance.tool --type foo.bar
-```
+cloudevents send http://localhost:8080 --id abc-123 --source cloudevents.conformance.tool --type foo.bar
+```