Add PACKAGE.md for CloudNative.CloudEvents #309
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Safia Abdalla <safia@safia.rocks>
captainsafia
force-pushed
the
package-md
branch
from
2df98db
to
b79a4b3
Compare
jskeet
reviewed
Aug 23, 2024
| }; | ||
| ``` | ||
|
|
||
| This package only provides the abstractions for constructing a CloudEvent. For complete deserialization and serialization behavior, you will need to use an accompanying formatter library. For more information on configuring and using CloudNative.CloudEvents, refer to the [official documentation](https://github.com/cloudevents/sdk-csharp/tree/main/docs). |
There was a problem hiding this comment.
Possibly give an example one such formatter library? (I'd use the System.Text.Json formatter, personally.)
| ## Key Features | ||
|
|
||
| * Supports constructing a spec-compliant CloudEvent | ||
| * Provides abstractions for building custom CloudEvent formatters |
There was a problem hiding this comment.
Possibly add the HTTP binding support that's in this core package?
| The main types provided by this library are: | ||
|
|
||
| * `CloudEvent`: Represents a spec-compliant CloudEvent. | ||
| * `CloudEventFormatter`: Provides an abstract class that can be extended to implement an event formatter. |
There was a problem hiding this comment.
Possibly mention extension methods (the names of the types are probably irrelevant) for HTTP conversion?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contributes to #290.
Starting off with just a PACKAGE.md for the central package. If this format looks good, I'll copy it to the other packages.