diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index e516c21..7afaee4 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -36,5 +36,5 @@ jobs: - name: Push NuGet Package to GitHub run: dotnet nuget push "build/*" --source "github" --api-key ${{ secrets.GITHUB_TOKEN }} --skip-duplicate - # - name: Push NuGet Package to nuget.org - # run: dotnet nuget push "build/*" --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }} --skip-duplicate + - name: Push NuGet Package to nuget.org + run: dotnet nuget push "build/*" --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }} --skip-duplicate diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml index 4afd0de..8a41178 100644 --- a/.github/workflows/prerelease.yml +++ b/.github/workflows/prerelease.yml @@ -36,8 +36,8 @@ jobs: - name: Push NuGet Package to GitHub run: dotnet nuget push "build/*" --source "github" --api-key ${{ secrets.GITHUB_TOKEN }} --skip-duplicate - # - name: Push NuGet Package to nuget.org - # run: dotnet nuget push "build/*" --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }} --skip-duplicate + - name: Push NuGet Package to nuget.org + run: dotnet nuget push "build/*" --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }} --skip-duplicate - name: Create Release uses: "marvinpinto/action-automatic-releases@latest" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 238e964..e449c9f 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -36,8 +36,8 @@ jobs: - name: Push NuGet Package to GitHub run: dotnet nuget push "build/*" --source "github" --api-key ${{ secrets.GITHUB_TOKEN }} --skip-duplicate - # - name: Push NuGet Package to nuget.org - # run: dotnet nuget push "build/*" --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }} --skip-duplicate + - name: Push NuGet Package to nuget.org + run: dotnet nuget push "build/*" --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }} --skip-duplicate - name: Create Release uses: "marvinpinto/action-automatic-releases@latest" diff --git a/README.md b/README.md new file mode 100644 index 0000000..a074171 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +

TcpDotNet

+

+GitHub Workflow Status +GitHub Issues +NuGet Downloads +Stable Version +Nightly Version +MIT License +

+ +### 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.