docs: improve for CloudEvents (#475)

Lindurion · web-flow · commit bab6e2f8842d · 2024-12-16T13:39:41.000-08:00
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
+```

Original file line number	Diff line number	Diff line change
@@ -34,7 +34,7 @@ Add a `package.json` script to start the Functions Framework and pass the name o
`34`	`34`	```sh
`35`	`35`	`{`
`36`	`36`	`"scripts": {`
`37`		`- "start": "functions-framework --target=helloCloudEvents"`
	`37`	`+ "start": "functions-framework --target=helloCloudEvents --signature-type=cloudevent"`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`	```
@@ -51,5 +51,5 @@ it is no longer accessible via `HTTP GET` requests from the browser.
`51`	`51`	`### Create and Send a CloudEvent to the Function`
`52`	`52`
`53`	`53`	```
`54`		`-cloudevents send http://localhost:8080 --specver--id abc-123 --source cloudevents.conformance.tool --type foo.bar`
`55`		-```
	`54`	`+cloudevents send http://localhost:8080 --id abc-123 --source cloudevents.conformance.tool --type foo.bar`
	`55`	+```