From f8e5d01be6fc2888d93c7f11430ac91b04cd1098 Mon Sep 17 00:00:00 2001 From: luzhan <513964121@qq.com> Date: Wed, 10 Jul 2024 22:46:39 +0800 Subject: [PATCH] doc: update a badge in README --- .github/workflows/publish.yml | 11 +++-------- README.md | 12 ++++++++---- README_ZH.md | 12 ++++++++++-- 3 files changed, 21 insertions(+), 14 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 243073b..a14fc54 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -1,4 +1,4 @@ -name: Release to NuGet and GitHub Packages +name: Release to NuGet on: release: @@ -24,16 +24,11 @@ jobs: - name: Package Projects run: | - dotnet pack src/Apache.IoTDB/Apache.IoTDB.csproj -c Release -p:PackageVersion=${{ github.event.release.tag_name }} --no-build -o nupkgs /p:PackageId=test_proj_1 - dotnet pack src/Apache.IoTDB.Data/Apache.IoTDB.Data.csproj -c Release -p:PackageVersion=${{ github.event.release.tag_name }} --no-build -o nupkgs /p:PackageId=test_proj_2 + dotnet pack src/Apache.IoTDB/Apache.IoTDB.csproj -c Release -p:PackageVersion=${{ github.event.release.tag_name }} --no-build -o nupkgs /p:PackageId=Apache.IoTDB + dotnet pack src/Apache.IoTDB.Data/Apache.IoTDB.Data.csproj -c Release -p:PackageVersion=${{ github.event.release.tag_name }} --no-build -o nupkgs /p:PackageId=Apache.IoTDB.Data - name: Publish Packages to NuGet run: | dotnet nuget push "nupkgs/*.nupkg" --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json env: NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }} - - - name: Publish Packages to GitHub Packages - run: dotnet nuget push "nupkgs/*.nupkg" --api-key ${{ secrets.GITHUB_TOKEN }} --source https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index 454db4d..cb68491 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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`. @@ -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 diff --git a/README_ZH.md b/README_ZH.md index 71fc56e..718b578 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -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#语言客户端,与其他语言支持相同语义的用户接口。 @@ -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`的版本。 @@ -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) ### 命令行工具