diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index b0c2ed8ff..0d87b3274 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,7 @@ blank_issues_enabled: false contact_links: - name: Discussion - url: https://github.com/nats-io/nats.net.v2/discussions + url: https://github.com/nats-io/nats.net/discussions about: Ideal for ideas, feedback, or longer form questions. - name: Chat url: https://slack.nats.io diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d619ceeb..6bc5f6f84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Thanks for your interest in contributing! This document contains `nats-io/nats.net.v2` specific contributing details. If you are a first-time contributor, please refer to the general [NATS Contributor Guide](https://nats.io/contributing/) to get a comprehensive overview of contributing to the NATS project. +Thanks for your interest in contributing! This document contains `nats-io/nats.net` specific contributing details. If you are a first-time contributor, please refer to the general [NATS Contributor Guide](https://nats.io/contributing/) to get a comprehensive overview of contributing to the NATS project. ## Getting started @@ -10,7 +10,7 @@ There are three general ways you can contribute to this repo: - Reporting a bug or regression - Contributing changes to the source code -For the first two, refer to the [GitHub Issues](https://github.com/nats-io/nats.net.v2/issues/new/choose) which guides you through the available options along with the needed information to collect. +For the first two, refer to the [GitHub Issues](https://github.com/nats-io/nats.net/issues/new/choose) which guides you through the available options along with the needed information to collect. ## Contributing Changes @@ -34,4 +34,4 @@ A good pull request includes: ## Get Help -If you have questions about the contribution process, please start a [GitHub discussion](https://github.com/nats-io/nats.net.v2/discussions) or join the [NATS Slack](https://slack.nats.io/). +If you have questions about the contribution process, please start a [GitHub discussion](https://github.com/nats-io/nats.net/discussions) or join the [NATS Slack](https://slack.nats.io/). diff --git a/README.md b/README.md index 4b5300ede..ec96b447d 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,12 @@ Head over to [NATS documentation](https://docs.nats.io/nats-concepts/overview) f ## Quick Start +Install the [NATS.Net](https://www.nuget.org/packages/NATS.Net) package from NuGet: + +```bash +dotnet add package NATS.Net +``` + Basic messaging: ```csharp @@ -48,9 +54,10 @@ await foreach (var msg in nc.SubscribeAsync(subject: "foo")) await nc.PublishAsync(subject: "foo", data: "Hello, World!"); ``` -Persistance with JetStream: +Persistence with JetStream: ```csharp +// NATS JetStream basic publish-consume example await using var nc = new NatsClient(); var js = nc.CreateJetStreamContext(); diff --git a/docs/documentation/advanced/security.md b/docs/documentation/advanced/security.md index 366380074..09e7d224a 100644 --- a/docs/documentation/advanced/security.md +++ b/docs/documentation/advanced/security.md @@ -5,7 +5,7 @@ All you need to do is to pass your credentials to the connection. [!code-csharp[](../../../tests/NATS.Net.DocsExamples/Advanced/SecurityPage.cs#user-pass)] -See also [user authentication tests](https://github.com/nats-io/nats.net.v2/blob/main/tests/NATS.Client.Core.Tests/NatsConnectionTest.Auth.cs) for more examples. +See also [user authentication tests](https://github.com/nats-io/nats.net/blob/main/tests/NATS.Client.Core.Tests/NatsConnectionTest.Auth.cs) for more examples. ## Implicit TLS Connections diff --git a/docs/toc.yml b/docs/toc.yml index f9422ed9b..b49e5aebc 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -6,7 +6,7 @@ homepage: api/index.md - name: GitHub - href: https://github.com/nats-io/nats.net.v2 + href: https://github.com/nats-io/nats.net - name: Slack - href: https://natsio.slack.com/channels/dotnet + href: https://slack.nats.io