Adjusting the readme to be for v2, rename ToEventMessage to ToMessage #386
Conversation
Signed-off-by: Scott Nichols <snichols@vmware.com>
Signed-off-by: Scott Nichols <snichols@vmware.com>
There was a problem hiding this comment.
Ok in the README.md you wrote three examples of three different usages of the sdk:
- map
event.Eventto/from JSON - use
binding.Message - use
client.Client
I propose to have subparagraphs for these in this order:
- Marshal/Unmarshal events to/from JSON
- Send/Receive events over HTTP
- Encode/Decode HTTP Request/Responses directly
| We will target ~2 months of development to release v2 of this SDK with an end | ||
| date of March 27, 2020. You can read more about the plan for SDK v2 in the | ||
| [SDK v2 planning doc](./docs/SDK_v2.md). | ||
| **v2.0.0-preview1:** |
There was a problem hiding this comment.
Don't forget to update it to preview2 😉
There was a problem hiding this comment.
this was for preview1 that we cut last week. preview2 is for this week.
README.md
Outdated
| ``` | ||
|
|
||
| Creating a minimal CloudEvent in version 1.0: | ||
| The SDK can help bind this to a specific protocol, in this case HTTP Request: |
There was a problem hiding this comment.
Before this sentence, I would add just a quick explanation of what is binding.Message, something like:
binding.Message is an abstraction to read a protocol specific message as a CloudEvent, without fully parsing it to
cloudevents.Event, in order to allow optimized message passing between different protocols.
README.md
Outdated
| ``` | ||
|
|
||
| Sending a cloudevents.Event via the HTTP Transport with Binary v1.0 encoding: | ||
| The SDK can let you stay at the `Event` level if you want to use the `Client`. |
There was a problem hiding this comment.
This one should live before the binding.Message example
Signed-off-by: Scott Nichols <snichols@vmware.com>
Signed-off-by: Scott Nichols <snichols@vmware.com>
Signed-off-by: Scott Nichols <snichols@vmware.com>
Signed-off-by: Scott Nichols snichols@vmware.com