Merge pull request #23 from dotnet-campus/t/lindexi/doc-zh

加上文档

Author: lindexi

README.md

@@ -1,8 +1,74 @@
 # dotnetCampus.AsyncWorkerCollection
 
-多线程异步工具
+[中文](README.zh-cn.md)
 
 | Build | NuGet |
 | -- | -- |
 |![](https://github.com/dotnet-campus/AsyncWorkerCollection/workflows/.NET%20Core/badge.svg)|[![](https://img.shields.io/nuget/v/dotnetCampus.AsyncWorkerCollection.svg)](https://www.nuget.org/packages/dotnetCampus.AsyncWorkerCollection)|
 
+A collection of tools that support asynchronous methods and support high-performance multithreading.
+
+## Install NuGet package
+
+Two different libraries are provided for installation.
+
+### Install the traditionary NuGet Dll library
+
+.NET CLI:
+
+```
+dotnet add package dotnetCampus.AsyncWorkerCollection
+```
+
+PackageReference:
+
+```xml
+<PackageReference Include="dotnetCampus.AsyncWorkerCollection" Version="1.2.1" />
+```
+
+### Install the [SourceYard](https://github.com/dotnet-campus/SourceYard) NuGet source code
+
+.NET CLI:
+
+```
+dotnet add package dotnetCampus.AsyncWorkerCollection.Source --version 1.2.1
+```
+
+PackageReference:
+
+```xml
+<PackageReference Include="dotnetCampus.AsyncWorkerCollection.Source" Version="1.2.1">
+  <PrivateAssets>all</PrivateAssets>
+  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+</PackageReference>
+```
+
+## Usage
+
+### AsyncQueue
+
+An asynchronous queue that supports multiple threads
+
+Create a queue:
+
+```csharp
+    var asyncQueue = new AsyncQueue<FooTask>();
+```
+
+Add task to queue:
+
+```csharp
+   asyncQueue.Enqueue(new FooTask());
+```
+
+Waiting for the task to dequeue:
+
+```csharp
+    var fooTask = await asyncQueue.DequeueAsync();
+```
+
+## Contributing
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/dotnet-campus/AsyncWorkerCollection/pulls)
+
+If you would like to contribute, feel free to create a [Pull Request](https://github.com/dotnet-campus/AsyncWorkerCollection/pulls), or give us [Bug Report](https://github.com/dotnet-campus/AsyncWorkerCollection/issues/new).

README.zh-cn.md

@@ -0,0 +1,40 @@
+# dotnetCampus.AsyncWorkerCollection
+
+一个支持异步方法和支持高性能多线程的工具集合
+
+
+## 安装 NuGet 包
+
+这个库提供了两个不同的包可以给大家安装。其中一个包是传统的 Dll 引用包。另一个包是使用 [SourceYard](https://github.com/dotnet-campus/SourceYard) 打出来的源代码包，源代码包安装之后将会引用源代码
+
+### 安装传统 NuGet Dll 库
+
+.NET CLI:
+
+```
+dotnet add package dotnetCampus.AsyncWorkerCollection
+```
+
+PackageReference:
+
+```xml
+<PackageReference Include="dotnetCampus.AsyncWorkerCollection" Version="1.2.1" />
+```
+
+### 安装源代码包
+
+.NET CLI:
+
+```
+dotnet add package dotnetCampus.AsyncWorkerCollection.Source --version 1.2.1
+```
+
+PackageReference:
+
+```xml
+<PackageReference Include="dotnetCampus.AsyncWorkerCollection.Source" Version="1.2.1">
+  <PrivateAssets>all</PrivateAssets>
+  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+</PackageReference>
+```
+