Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add getting started docs #126

Merged
merged 1 commit into from
Jun 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,29 @@ title: Getting started
sidebar_label: Getting Started
---

.NET ActiveMQ Artemis Core Client is an open-source effort to equip .NET developers with a powerful, straightforward client for Apache ActiveMQ Artemis. Utilizing the broker's Core protocol, this library focuses on high-performance messaging, ensuring compatibility and comprehensive feature support with Apache ActiveMQ Artemis.
ArtemisNetCoreClient is an open-source effort to equip .NET developers with a powerful, straightforward client for Apache ActiveMQ Artemis. Utilizing the broker's CORE protocol, this library focuses on high-performance messaging, ensuring compatibility and comprehensive feature support with Apache ActiveMQ Artemis.

## Installation

.NET ActiveMQ Artemis Core Client is distributed via [NuGet](https://www.nuget.org/packages/ArtemisNetCoreClient). You can add ArtemisNetCoreClient NuGet package using dotnet CLI:
The library is distributed via [NuGet](https://www.nuget.org/packages/ArtemisNetCoreClient). You can add ArtemisNetCoreClient NuGet package using dotnet CLI:

```sh
dotnet add package ArtemisNetCoreClient --prerelease
```

## API overview

The API interfaces and classes are defined in the `ActiveMQ.Artemis.Core.Client` namespace:

```csharp
using ActiveMQ.Artemis.Core.Client;
```

The main API interfaces and classes are:

- `IConnection`: represents a connection with the broker
- `ConnectionFactory`: constructs `IConnection` instances
- `ISession`: represents a context for producing and consuming messages
- `IConsumer`: represents a message consumer
- `IProducer`: represents a message producer attached to a specified *address*
- `IAnonymousProducer`: represents a message producer capable of sending messages to multiple addresses
2 changes: 1 addition & 1 deletion website/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ function Home() {
return (
<Layout
title={siteConfig.title}
description="Unofficial ActiveMQ Artemis .NET Client for .NET Core and .NET Framework">
description="Unofficial ActiveMQ Artemis .NET CORE Client">
<header className={classnames('hero hero--primary', styles.heroBanner)}>
<div className="container">
<h1 className="hero__title">{siteConfig.title}</h1>
Expand Down
Loading