Skip to content

Commit

Permalink
add links and installation section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
luca-schlecker committed May 1, 2024
1 parent c44ad9b commit 3b2d8ff
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@

<p align="center">
<img src="https://raw.githubusercontent.com/luca-schlecker/SwebSocket/main/icon.png" />
<a href="https://github.com/luca-schlecker/SwebSocket"><img src="https://raw.githubusercontent.com/luca-schlecker/SwebSocket/main/icon.png" /></a>
</p>
<h1 align="center">SwebSocket</h1>
<p align="center">
<img src="https://img.shields.io/nuget/dt/SwebSocket" alt="NuGet Downloads" />
<img src="https://img.shields.io/github/license/luca-schlecker/SwebSocket" alt="GitHub License" />
<img src="https://img.shields.io/nuget/v/SwebSocket" alt="NuGet Version" />
<a href="https://www.nuget.org/packages/SwebSocket"><img src="https://img.shields.io/nuget/dt/SwebSocket" alt="NuGet Downloads" /></a>
<a href="https://github.com/luca-schlecker/SwebSocket/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/luca-schlecker/SwebSocket" alt="GitHub License" /></a>
<a href="https://www.nuget.org/packages/SwebSocket"><img src="https://img.shields.io/nuget/v/SwebSocket" alt="NuGet Version" /></a>
</p>

A handwritten, easy to use WebSocket Library that aims to:
Expand All @@ -21,6 +21,15 @@ A handwritten, easy to use WebSocket Library that aims to:
> [!WARNING]
> This is a fun-project and may contain severe errors. You should probably not use this in production.
## Installation

This Library is on [NuGet](https://www.nuget.org/packages/SwebSocket) and can thus be installed in many ways, including but not limited to:
- [Dotnet CLI](https://learn.microsoft.com/nuget/consume-packages/install-use-packages-dotnet-cli)
- [Visual Studio NuGet Package Manager](https://learn.microsoft.com/nuget/consume-packages/install-use-packages-visual-studio)
- [NuGet for Unity](https://github.com/GlitchEnzo/NuGetForUnity)

There are more provided on the NuGet Page.

## Examples
### Client
#### Echo Client (Manual)
Expand Down
13 changes: 11 additions & 2 deletions README.nuget.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# ![SwebSocket Logo](https://raw.githubusercontent.com/luca-schlecker/SwebSocket/main/icon.png) SwebSocket
# [![SwebSocket Logo](https://raw.githubusercontent.com/luca-schlecker/SwebSocket/main/icon.png)](https://github.com/luca-schlecker/SwebSocket) SwebSocket

![NuGet Downloads](https://img.shields.io/nuget/dt/SwebSocket) ![GitHub License](https://img.shields.io/github/license/luca-schlecker/SwebSocket) ![NuGet Version](https://img.shields.io/nuget/v/SwebSocket)
[![NuGet Downloads](https://img.shields.io/nuget/dt/SwebSocket)](https://www.nuget.org/packages/SwebSocket) [![GitHub License](https://img.shields.io/github/license/luca-schlecker/SwebSocket)](https://github.com/luca-schlecker/SwebSocket/blob/main/LICENSE.md) [![NuGet Version](https://img.shields.io/nuget/v/SwebSocket)](https://www.nuget.org/packages/SwebSocket)

A handwritten, easy to use WebSocket Library that aims to:
- Follow [RFC6455](https://datatracker.ietf.org/doc/html/rfc6455)
Expand All @@ -16,6 +16,15 @@ A handwritten, easy to use WebSocket Library that aims to:
>
> This is a fun-project and may contain severe errors. You should probably not use this in production.
## Installation

This Library is on [NuGet](https://www.nuget.org/packages/SwebSocket) and can thus be installed in many ways, including but not limited to:
- [Dotnet CLI](https://learn.microsoft.com/nuget/consume-packages/install-use-packages-dotnet-cli)
- [Visual Studio NuGet Package Manager](https://learn.microsoft.com/nuget/consume-packages/install-use-packages-visual-studio)
- [NuGet for Unity](https://github.com/GlitchEnzo/NuGetForUnity)

There are more provided on the NuGet Page.

## Examples
### Client
#### Echo Client (Manual)
Expand Down

0 comments on commit 3b2d8ff

Please sign in to comment.