Skip to content

Commit fdaeac9

Browse files
authored
Enrich the README (#1001)
1 parent df7f72d commit fdaeac9

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ The .NET client itself is distributed via NuGet as a package named [Hazelcast.NE
1212

1313
The Hazelcast .NET solution is Open Source, released under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), and welcomes contributions. The project lives here on [GitHub](https://github.com/hazelcast/hazelcast-csharp-client), where you can obtain the source code, report issues, and interract with the community. Contributions are welcome!
1414

15+
16+
## Extension Packages
17+
In addition to the core `Hazelcast.Net` client package, there are several extension packages that provide additional functionality. These include:
18+
19+
- `Hazelcast.Net.DependencyInjection`: Provides integration with Microsoft's Dependency Injection framework which is also used with ASP.NET.
20+
- `Hazelcast.Net.Caching`: Adds caching capabilities to the Hazelcast .NET client by implementing `IDistributedCache`.
21+
- `Hazelcast.Net.Linq.Async`: Enables LINQ support for asynchronous map querying with Hazelcast.
22+
1523
## Versions
1624

1725
Browse to [this page](http://hazelcast.github.io/hazelcast-csharp-client/versions.html) for details about versions.
@@ -22,6 +30,23 @@ See [this branch](https://github.com/hazelcast/hazelcast-csharp-client/tree/3.12
2230

2331
Check the [Hazelcast.Net.Examples](https://github.com/hazelcast/hazelcast-csharp-client/tree/master/src/Hazelcast.Net.Examples) project.
2432

33+
Here is a simple example that connects to a Hazelcast server running on localhost, puts and gets a value from a distributed map.
34+
```csharp
35+
var options = new HazelcastOptionsBuilder()
36+
.With(o=> o.Networking.Addresses.Add("127.0.0.1:5701"))
37+
.Build();
38+
39+
// create an Hazelcast client and connect to a server running on localhost
40+
await using var client = await HazelcastClientFactory.StartNewClientAsync(options);
41+
42+
// get the distributed map from the cluster
43+
await using var map = await client.GetMapAsync<string, string>("simple-example");
44+
45+
await map.PutAsync("my-key", "my-value");
46+
47+
var value = await map.GetAsync("my-key");
48+
```
49+
2550
## Contributing
2651

2752
We encourage any type of contribution in the form of issue reports or pull requests.

0 commit comments

Comments
 (0)