Skip to content

Commit

Permalink
Update Publish Content and README (#9)
Browse files Browse the repository at this point in the history
Co-authored-by: Haonan <[email protected]>
  • Loading branch information
lausannel and HTHou authored Jul 19, 2024
1 parent 58cf1db commit 1d15a27
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 8 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*.userosscache
*.sln.docstates
**/tmp
nupkgs/

# Build results
[Dd]ebug/
Expand Down
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@

[![E2E Tests](https://github.com/apache/iotdb-client-csharp/actions/workflows/e2e.yml/badge.svg)](https://github.com/apache/iotdb-client-csharp/actions/workflows/e2e.yml)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![NuGet Badge](https://buildstats.info/nuget/Apache.IoTDB)](https://www.nuget.org/packages/Apache.IoTDB)

## Overview

This is the C# client of Apache IoTDB.
Expand All @@ -37,12 +39,14 @@ Apache IoTDB Github: https://github.com/apache/iotdb

### Install from NuGet Package

We have prepared Nuget Package for C# users. Users can directly install the client through .NET CLI. [The link of our NuGet Package is here](https://www.nuget.org/packages/Apache.IoTDB/). Run the following command in the command line to complete installation
We have prepared a Nuget Package for C# users. Users can directly install the Apache IoTDB client using the .NET CLI. To install, simply run the following command in your command line:

```sh
```bash
dotnet add package Apache.IoTDB
```

For more details, visit the package on [NuGet](https://www.nuget.org/packages/Apache.IoTDB/).

> [!NOTE]
> The `Apache.IoTDB` package only supports versions greater than `.net framework 4.6.1`.
Expand All @@ -68,8 +72,8 @@ NLog >= 4.7.9

### OS

* Linux, MacOS or other unix-like OS
* Windows+bash(WSL, cygwin, Git Bash)
* Linux, MacOS or other Unix-like OS
* Windows + Bash (WSL, cygwin, Git Bash)

### Command Line Tools

Expand Down
12 changes: 10 additions & 2 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
# Apache IoTDB C#语言客户端
[![E2E Tests](https://github.com/apache/iotdb-client-csharp/actions/workflows/e2e.yml/badge.svg)](https://github.com/apache/iotdb-client-csharp/actions/workflows/e2e.yml)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![NuGet Badge](https://buildstats.info/nuget/Apache.IoTDB)](https://www.nuget.org/packages/Apache.IoTDB)

## 概览

本仓库是Apache IoTDB的C#语言客户端,与其他语言支持相同语义的用户接口。
Expand All @@ -35,10 +37,16 @@ Apache IoTDB Github: https://github.com/apache/iotdb
### 从NuGet Package安装

我们为CSharp用户准备了NuGet包,用户可直接通过.NET CLI进行客户端安装,[NuGet包链接如下](https://www.nuget.org/packages/Apache.IoTDB/),命令行中运行如下命令即可完成安装

我们为 C# 用户准备了一个 Nuget 包。用户可以直接通过 .NET CLI 进行客户端安装。命令行中运行如下命令即可完成安装

```sh
dotnet add package Apache.IoTDB
```

详情请访问 [NuGet 上的包](https://www.nuget.org/packages/Apache.IoTDB/)


> [!NOTE]
> 请注意,`Apache.IoTDB`这个包仅支持大于`.net framework 4.6.1`的版本。
Expand All @@ -64,8 +72,8 @@ NLog >= 4.7.9

### 操作系统

* Linux、MacOS或其他类unix系统
* Windows+bash(WSL、cygwin、Git Bash)
* Linux、MacOS 或其他类 Unix 系统
* Windows + Bash (WSL、cygwin、Git Bash)

### 命令行工具

Expand Down
7 changes: 5 additions & 2 deletions src/Apache.IoTDB/Apache.IoTDB.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@
<TargetFrameworks>net5.0;net6.0;netstandard2.1;netstandard2.0;net461</TargetFrameworks>
<LangVersion>latest</LangVersion>
<Authors>eedalong, lausannel, MysticBoy, Aiemu, HTHou</Authors>
<Company>LiuLin Lab</Company>
<PackageDescription>C# client for Apache IoTDB</PackageDescription>
<PackageProjectUrl>https://github.com/apache/iotdb-client-csharp</PackageProjectUrl>
<RepositoryUrl>https://github.com/apache/iotdb-client-csharp</RepositoryUrl>

<Description>
C# client of Apache IoTDB.

[Apache IoTDB](https://iotdb.apache.org) (Internet of Things Database) is a data management system for time series data, which can provide users specific services, such as, data collection, storage and analysis. Due to its light weight structure, high performance and usable features together with its seamless integration with the Hadoop and Spark ecology, IoTDB meets the requirements of massive dataset storage, high throughput data input, and complex data analysis in the industrial IoT field.
</Description>

</PropertyGroup>

Expand Down

0 comments on commit 1d15a27

Please sign in to comment.