Skip to content

Commit fbfee02

Browse files
add nuget-specific readme file
1 parent ae1ec7e commit fbfee02

File tree

2 files changed

+37
-2
lines changed

2 files changed

+37
-2
lines changed

ClickHouse.Driver/ClickHouse.Driver.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<Authors>ClickHouse</Authors>
1212
<Description>Fast binary-over-HTTP ADO.NET provider for ClickHouse</Description>
1313
<PackageLicenseExpression>MIT</PackageLicenseExpression>
14-
<PackageReadmeFile>README.md</PackageReadmeFile>
14+
<PackageReadmeFile>README.nuget.md</PackageReadmeFile>
1515
<PublishRepositoryUrl>true</PublishRepositoryUrl>
1616
<IncludeSymbols>true</IncludeSymbols>
1717
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
@@ -29,7 +29,7 @@
2929
</Target>
3030

3131
<ItemGroup>
32-
<None Include="..\README.md" Link="README.md" Pack="true" PackagePath="" />
32+
<None Include="..\README.nuget.md" Link="README.nuget.md" Pack="true" PackagePath="" />
3333
</ItemGroup>
3434

3535
<ItemGroup>

README.nuget.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# ClickHouse C# client
2+
3+
## About
4+
5+
Official C#/ADO.NET client for [ClickHouse](https://clickhouse.com/).
6+
7+
* High performance
8+
* Supports bulk insertion
9+
* Uses compressed binary protocol over HTTP(S)
10+
* Available for .NET Core/Framework/Standard
11+
12+
## Documentation
13+
14+
See the [ClickHouse website](https://clickhouse.com/docs/integrations/csharp) for full documentation.
15+
16+
## Usage examples
17+
18+
We have a wide range of [examples](https://github.com/ClickHouse/clickhouse-cs/tree/main/examples), aiming to cover typical scenarios of client usage.
19+
20+
## ClickHouse Versions
21+
22+
The supported versions ofthe ClickHouse database server coincide with the versions currently receiving security updates.
23+
24+
For the list of currently supported versions, see [here](https://github.com/ClickHouse/ClickHouse/blob/master/SECURITY.md#security-change-log-and-support).
25+
26+
## Contact us
27+
28+
If you have any questions or need help, feel free to reach out to us in the [Community Slack](https://clickhouse.com/slack) or via [GitHub issues](https://github.com/ClickHouse/clickhouse-cs/issues).
29+
30+
## Contributing
31+
32+
Contributions are welcome and highly appreciated! Check out our [contributing guide](https://github.com/ClickHouse/clickhouse-cs/blob/main/CONTRIBUTING.md).
33+
34+
## Acknowledgements
35+
Originally created by [Oleg V. Kozlyuk](https://github.com/DarkWanderer)

0 commit comments

Comments
 (0)