Skip to content

Commit

Permalink
Add small README for each project being released.
Browse files Browse the repository at this point in the history
Signed-off-by: Yury-Fridlyand <yuryf@bitquilltech.com>
  • Loading branch information
Yury-Fridlyand committed Aug 23, 2022
1 parent 8ba377a commit 8a8b5bb
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/OpenSearch.Client.JsonNetSerializer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
An auxiliary tool used by `OpenSearch.Client` to serialize and deserialize data.
3 changes: 3 additions & 0 deletions src/OpenSearch.Client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
`OpenSearch.Client` is a high level OpenSearch .NET client that still maps very closely to the original OpenSearch API. All requests and responses are exposed through types, making it ideal for getting up and running quickly.

Under the covers, `OpenSearch.Client` uses the `OpenSearch.Net` low level client to dispatch requests and responses, using and extending many of the types within `OpenSearch.Net`. The low level client itself is still exposed on the high level client through the `.LowLevel` property.
1 change: 1 addition & 0 deletions src/OpenSearch.Net.VirtualizedCluster/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A utility used by unit tests of `OpenSearch.Net` and `OpenSearch.Client`. It allows to create a fake virtual OpenSearch cluster to test and debug REST API calls.
3 changes: 3 additions & 0 deletions src/OpenSearch.Net/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
A low-level, dependency free OpenSearch .Net client.

It provides a one-to-one mapping with the OpenSearch REST API. The client is completely matches the official REST API specification and supports all OpenSearch features. The client also has support for load balancing and cluster failover and all client method calls have both synchronous and asynchronous variants

0 comments on commit 8a8b5bb

Please sign in to comment.