Add getting started docs (#126)

Havret · Jun 8, 2024 · aeafabe · aeafabe
1 parent 5825f3f
commit aeafabe
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -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
diff --git a/website/src/pages/index.js b/website/src/pages/index.js
@@ -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>