31 lines
2.1 KiB
Markdown
31 lines
2.1 KiB
Markdown
<h1 align="center">TcpDotNet</h1>
|
|
<p align="center">
|
|
<a href="https://github.com/oliverbooth/TcpDotNet/actions/workflows/dotnet.yml"><img src="https://img.shields.io/github/actions/workflow/status/oliverbooth/TcpDotNet/dotnet.yml?branch=main" alt="GitHub Workflow Status" title="GitHub Workflow Status"></a>
|
|
<a href="https://github.com/oliverbooth/TcpDotNet/issues"><img src="https://img.shields.io/github/issues/oliverbooth/TcpDotNet" alt="GitHub Issues" title="GitHub Issues"></a>
|
|
<a href="https://www.nuget.org/packages/TcpDotNet/"><img src="https://img.shields.io/nuget/dt/TcpDotNet" alt="NuGet Downloads" title="NuGet Downloads"></a>
|
|
<a href="https://www.nuget.org/packages/TcpDotNet/"><img src="https://img.shields.io/nuget/v/TcpDotNet?label=stable" alt="Stable Version" title="Stable Version"></a>
|
|
<a href="https://www.nuget.org/packages/TcpDotNet/"><img src="https://img.shields.io/nuget/vpre/TcpDotNet?label=nightly" alt="Nightly Version" title="Nightly Version"></a>
|
|
<a href="https://github.com/oliverbooth/TcpDotNet/blob/master/LICENSE.md"><img src="https://img.shields.io/github/license/oliverbooth/TcpDotNet" alt="MIT License" title="MIT License"></a>
|
|
</p>
|
|
|
|
### About
|
|
TcpDotNet is a .NET Standard 2.1 package that enables you to perform server/client communications over the TCP protocol.
|
|
This package is a work-in-progress and not deemed ready for production use. However, it is available on NuGet as a very crude and early development build. This package will be maintained as I see fit.
|
|
|
|
*(I'm also [dogfooding](https://www.pcmag.com/encyclopedia/term/dogfooding) this library, so there's that.)*
|
|
|
|
## Installation
|
|
### NuGet installation
|
|
```ps
|
|
Install-Package TcpDotNet -Version 0.1.0-nightly.1
|
|
```
|
|
|
|
### Manual installation
|
|
Download the [latest release](https://github.com/oliverbooth/TcpDotNet/releases/latest) from this repository and adding a direct assembly reference for your chosen platform.
|
|
|
|
## Contributing
|
|
Contributions are welcome. Feel free to open an issue or PR for any bugs you notice or features this library needs.
|
|
|
|
## License
|
|
TcpDotNet is released under the MIT License. See [here](https://github.com/oliverbooth/TcpDotNet/blob/master/LICENSE.md) for more details.
|