Skip to content

Update README #281

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.

Sign up for GitHub

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

Merged
g-despot merged 1 commit into from
Jan 27, 2026
Merged

Update README #281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 8 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@

Welcome to the official C# client for Weaviate, the open-source vector database. This library provides a convenient and idiomatic way for .NET developers to interact with a Weaviate instance.

> [!WARNING]
> This client is a **beta release and under active development**. We welcome your [feedback](#-feedback) and contributions!

---

## 🚀 Installation
Expand All @@ -31,7 +28,7 @@ Alternatively, you can add the `PackageReference` to your `.csproj` file:

The best way to get started is by following our quickstart guide. It will walk you through setting up the client, connecting to Weaviate, creating a collection, and performing your first vector search.

- **[➡️ Quickstart Guide](https://client-libraries-beta--docs-weaviate-io.netlify.app/weaviate/quickstart)**
- **[➡️ Quickstart Guide](https://docs.weaviate.io/weaviate/quickstart)**


### Quickstart example
Expand Down Expand Up @@ -81,11 +78,11 @@ foreach (var obj in response.Objects)

For more detailed information on specific features, please refer to the official documentation and the how-to guides.

- **[Client library overview](https://client-libraries-beta--docs-weaviate-io.netlify.app/weaviate/client-libraries/csharp)**
- **[How-to: Configure the client](https://client-libraries-beta--docs-weaviate-io.netlify.app/weaviate/configuration)**
- **[How-to: Manage collections](https://client-libraries-beta--docs-weaviate-io.netlify.app/weaviate/manage-collections)**
- **[How-to: Manage data objects](https://client-libraries-beta--docs-weaviate-io.netlify.app/weaviate/manage-objects)**
- **[How-to: Query & search data](https://client-libraries-beta--docs-weaviate-io.netlify.app/weaviate/search)**
- **[Client library overview](https://docs.weaviate.io/weaviate/client-libraries/csharp)**
- **[How-to: Configure the client](https://docs.weaviate.io/weaviate/configuration)**
- **[How-to: Manage collections](https://docs.weaviate.io/weaviate/manage-collections)**
- **[How-to: Manage data objects](https://docs.weaviate.io/weaviate/manage-objects)**
- **[How-to: Query & search data](https://docs.weaviate.io/weaviate/search)**

### Additional Guides

Expand All @@ -97,16 +94,11 @@ For more detailed information on specific features, please refer to the official

---

## 💬 Feedback

We would love to hear your feedback! For specific feature requests, bug reports, or issues with the client, please [open an issue](https://github.com/weaviate/csharp-client/issues) on this repository or reach out to us directly at **devex@weaviate.io**.

---

## 🤝 Community

Connect with the Weaviate community and the team through our online channels.
Connect with the Weaviate community and the team through our online channels. We would love to hear your feedback!

- **[GitHub Issues](https://github.com/weaviate/csharp-client/issues)**: For specific feature requests, bug reports, or issues with the client.
- **[Weaviate Forum](https://forum.weaviate.io/)**: For questions and discussions.
- **[Weaviate Slack](https://weaviate.io/slack)**: For live chats with the community and team.

Expand Down
Loading