You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by bl...@apache.org on 2023/05/09 09:58:05 UTC
[pulsar-dotpulsar] branch master updated: [Doc] Add links to client feature matrix in README.md (#151)
This is an automated email from the ASF dual-hosted git repository.
blankensteiner pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-dotpulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 7719fa5 [Doc] Add links to client feature matrix in README.md (#151)
7719fa5 is described below
commit 7719fa56ba42458f9ccfe88df6186815b6575427
Author: Jun Ma <60...@users.noreply.github.com>
AuthorDate: Tue May 9 17:58:00 2023 +0800
[Doc] Add links to client feature matrix in README.md (#151)
* Update README.md
* Update README.md
---
README.md | 32 ++++++++++++++++++--------------
1 file changed, 18 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index afefd48..39525f9 100644
--- a/README.md
+++ b/README.md
@@ -14,8 +14,8 @@ Have a look at the [changelog](CHANGELOG.md).
Let's take a look at a "Hello world" example, where we first produce a message and then consume it. Note that the topic and subscription will be created if they don't exist.
-First, we need a Pulsar setup. Have a look [here](https://pulsar.apache.org/docs/en/standalone-docker/) to see how to setup a local standalone Pulsar instance.
-Install the NuGet package [DotPulsar](https://www.nuget.org/packages/DotPulsar/) and copy/paste the code below (you will be needing using declarations for 'DotPulsar' and 'DotPulsar.Extensions').
+First, we need a Pulsar setup. See [Pulsar docs](https://pulsar.apache.org/docs/getting-started-home/) for how to set up a local standalone Pulsar instance.
+Install the NuGet package [DotPulsar](https://www.nuget.org/packages/DotPulsar/) and copy/paste the code below (you will need to use declarations for 'DotPulsar' and 'DotPulsar.Extensions').
```csharp
const string myTopic = "persistent://public/default/mytopic";
@@ -50,16 +50,16 @@ For a more in-depth tour of the API, please visit the [Wiki](https://github.com/
- [X] Automatic reconnect
- [X] TLS connections
- [X] Pulsar Proxy
-- [X] Producer send with custom metadata
-- [X] Producer send with event time, sequence id, and delayed message delivery
-- [X] Producer send with key and ordering key
-- [X] Producer for partitioned topics
-- [X] Consumer subscription with initial position and priority level
-- [X] Consumer subscription types exclusive, shared, failover, and key shared
-- [X] Consumer receive and single + cumulative acknowledge
-- [X] Consumer and Reader seek on message-id and publish time
-- [X] Consumer unsubscribe
-- [X] Consume compacted topics
+- [X] Producer - send with custom metadata
+- [X] Producer - send with event time, sequence id, and delayed message delivery
+- [X] Producer - send with key and ordering key
+- [X] Producer - partitioned topics
+- [X] Consumer - subscription with initial position and priority level
+- [X] Consumer - subscription types exclusive, shared, failover, and key shared
+- [X] Consumer - receive and single + cumulative acknowledge
+- [X] Consumer/Reader - seek on message-id and publish time
+- [X] Consumer - unsubscribe
+- [X] Consumer - compacted topics
- [X] Reader API
- [X] Read/Consume/Acknowledge batched messages
- [X] Telemetry
@@ -83,13 +83,15 @@ For a more in-depth tour of the API, please visit the [Wiki](https://github.com/
- Time (using TimeSpan)
- Timestamp and Date (using DateTime)
+For a horizontal comparison with more language-specific clients, see [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).
+
## Roadmap
Help prioritizing the roadmap is most welcome, so please reach out and tell us what you want and need.
## Join Our Community
-Apache Pulsar has a [Slack instance](https://pulsar.apache.org/contact/) and there you'll find us in the #dev-dotpulsar channel.
+Apache Pulsar has a [Slack instance](https://pulsar.apache.org/contact/), and there you'll find us in the #dev-dotpulsar channel.
## Versioning
@@ -99,7 +101,9 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
* **Daniel Blankensteiner** - *Initial work* - [Danske Commodities](https://github.com/DanskeCommodities)
-See also the list of [contributors](https://github.com/apache/pulsar-dotpulsar/contributors) who participated in this project.
+Contributions are welcomed and greatly appreciated. See also the list of [contributors](https://github.com/apache/pulsar-dotpulsar/contributors) who participated in this project.
+
+If your contribution adds Pulsar features for C# clients, you need to update both the [Pulsar docs](https://pulsar.apache.org/docs/client-libraries/) and the [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/). See [Contribution Guide](https://pulsar.apache.org/contribute/site-intro/#pages) for more details.
## License