Documentation update. Especially regarding the roadmap.
diff --git a/README.md b/README.md
index 2e002c0..e79569f 100644
--- a/README.md
+++ b/README.md
@@ -50,24 +50,39 @@
## Roadmap
-1.0.0
+Help prioritizing the roadmap is most welcome, so please reach out and tell us what you want and need.
-* Move to IAsyncDisposable and IAsyncEnumerable (will mean moving to .NET Standard 2.1)
+### 1.0.0
+
+Before the first stable release, we should have a look at:
+
+* Use IAsyncDisposable
+* Use IAsyncEnumerable
* Consider using ValueTask instead of Task
+* Consider using nullable reference types
+* Look into the possibility of supporting .NET Standard 2.0
-X.X.X //Future
+### Future
-* Schema
-* Authentication/Authorization (TLS Authentication, Athenz, Kerberos)
-* Partitioned topics
-* Message compression (LZ4, ZLIB, ZSTD, SNAPPY)
-* Multi-topic subscriptions
-* Connection encryption
-* Message encryption
* Batching
-* CommandConsumerStats/CommandConsumerStatsResponse
-* CommandGetTopicsOfNamespace/CommandGetTopicsOfNamespaceResponse
-* CommandPartitionedTopicMetadata/CommandPartitionedTopicMetadataResponse
+* TLS connections
+* JSON Web Token Authentication
+
+### If requested by the community
+
+* Get consumer stats
+* Get topics of namespace
+* Message encryption
+* Schema
+* Partitioned topics
+* Multi-topic subscriptions
+* TLS Authentication
+* Athenz Authentication
+* Kerberos Authentication
+* LZ4 message compression
+* ZLIB message compression
+* ZSTD message compression
+* SNAPPY message compression
## Built With
diff --git a/src/DotPulsar/Abstractions/IConsumerBuilder.cs b/src/DotPulsar/Abstractions/IConsumerBuilder.cs
index 6f16feb..8fb4a66 100644
--- a/src/DotPulsar/Abstractions/IConsumerBuilder.cs
+++ b/src/DotPulsar/Abstractions/IConsumerBuilder.cs
@@ -11,22 +11,22 @@
IConsumerBuilder ConsumerName(string name);
/// <summary>
- /// Set initial position for the subscription. Default is 'Latest'.
+ /// Set initial position for the subscription. The default is 'Latest'.
/// </summary>
IConsumerBuilder InitialPosition(SubscriptionInitialPosition initialPosition);
/// <summary>
- /// Set the priority level for the shared subscription consumer. Default is 0.
+ /// Set the priority level for the shared subscription consumer. The default is 0.
/// </summary>
IConsumerBuilder PriorityLevel(int priorityLevel);
/// <summary>
- /// Number of messages that will be prefetched. Default is 1000.
+ /// Number of messages that will be prefetched. The default is 1000.
/// </summary>
IConsumerBuilder MessagePrefetchCount(uint count);
/// <summary>
- /// Whether to read from the compacted topic. Default is false.
+ /// Whether to read from the compacted topic. The default is 'false'.
/// </summary>
IConsumerBuilder ReadCompacted(bool readCompacted);
@@ -36,7 +36,7 @@
IConsumerBuilder SubscriptionName(string name);
/// <summary>
- /// Set the subscription type for this consumer. Default is 'Exclusive'.
+ /// Set the subscription type for this consumer. The default is 'Exclusive'.
/// </summary>
IConsumerBuilder SubscriptionType(SubscriptionType type);
diff --git a/src/DotPulsar/Abstractions/IProducerBuilder.cs b/src/DotPulsar/Abstractions/IProducerBuilder.cs
index c002ea8..9eb96fd 100644
--- a/src/DotPulsar/Abstractions/IProducerBuilder.cs
+++ b/src/DotPulsar/Abstractions/IProducerBuilder.cs
@@ -11,7 +11,7 @@
IProducerBuilder ProducerName(string name);
/// <summary>
- /// Set the initial sequence id. Default is 0.
+ /// Set the initial sequence id. The default is 0.
/// </summary>
IProducerBuilder InitialSequenceId(ulong initialSequenceId);
diff --git a/src/DotPulsar/Abstractions/IPulsarClientBuilder.cs b/src/DotPulsar/Abstractions/IPulsarClientBuilder.cs
index e7fa5b7..35fe1cb 100644
--- a/src/DotPulsar/Abstractions/IPulsarClientBuilder.cs
+++ b/src/DotPulsar/Abstractions/IPulsarClientBuilder.cs
@@ -8,12 +8,12 @@
public interface IPulsarClientBuilder
{
/// <summary>
- /// The time to wait before retrying an operation or a reconnect. Default is 3 seconds.
+ /// The time to wait before retrying an operation or a reconnect. The default is 3 seconds.
/// </summary>
IPulsarClientBuilder RetryInterval(TimeSpan interval);
/// <summary>
- /// The service URL for the Pulsar cluster. Default is "pulsar://localhost:6650".
+ /// The service URL for the Pulsar cluster. The default is "pulsar://localhost:6650".
/// </summary>
IPulsarClientBuilder ServiceUrl(Uri uri);
diff --git a/src/DotPulsar/Abstractions/IReaderBuilder.cs b/src/DotPulsar/Abstractions/IReaderBuilder.cs
index 8ce5250..5abc1ba 100644
--- a/src/DotPulsar/Abstractions/IReaderBuilder.cs
+++ b/src/DotPulsar/Abstractions/IReaderBuilder.cs
@@ -11,12 +11,12 @@
IReaderBuilder ReaderName(string name);
/// <summary>
- /// Number of messages that will be prefetched. Default is 1000.
+ /// Number of messages that will be prefetched. The default is 1000.
/// </summary>
IReaderBuilder MessagePrefetchCount(uint count);
/// <summary>
- /// Whether to read from the compacted topic. Default is false.
+ /// Whether to read from the compacted topic. The default is 'false'.
/// </summary>
IReaderBuilder ReadCompacted(bool readCompacted);
diff --git a/src/DotPulsar/DotPulsar.csproj b/src/DotPulsar/DotPulsar.csproj
index fdf077d..2759b9e 100644
--- a/src/DotPulsar/DotPulsar.csproj
+++ b/src/DotPulsar/DotPulsar.csproj
@@ -15,7 +15,7 @@
<Company>Danske Commodities A/S</Company>
<Copyright>$(Company)</Copyright>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
- <NoWarn>1701;1702;1591</NoWarn>
+ <NoWarn>1591;1701;1702</NoWarn>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
