VpSharp/README.md

30 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

<h1 align="center"><img src="branding_Banner.png"></h1>
2022-11-27 15:00:59 +00:00
<p align="center">
<a href="https://github.com/oliverbooth/VpSharp/actions?query=workflow%3A%22.NET%22"><img src="https://img.shields.io/github/actions/workflow/status/oliverbooth/VpSharp/dotnet.yml?style=flat-square" alt="GitHub Workflow Status" title="GitHub Workflow Status"></a>
<a href="https://github.com/oliverbooth/VpSharp/issues"><img src="https://img.shields.io/github/issues/oliverbooth/VpSharp?style=flat-square" alt="GitHub Issues" title="GitHub Issues"></a>
<a href="https://www.nuget.org/packages/VpSharp/"><img src="https://img.shields.io/nuget/dt/VpSharp?style=flat-square" alt="NuGet Downloads" title="NuGet Downloads"></a>
<a href="https://www.nuget.org/packages/VpSharp/"><img src="https://img.shields.io/nuget/v/VpSharp?label=stable&style=flat-square" alt="Stable Version" title="Stable Version"></a>
<a href="https://www.nuget.org/packages/VpSharp/"><img src="https://img.shields.io/nuget/vpre/VpSharp?label=nightly&style=flat-square" alt="Nightly Version" title="Nightly Version"></a>
<a href="https://github.com/oliverbooth/VpSharp/blob/master/LICENSE.md"><img src="https://img.shields.io/github/license/oliverbooth/VpSharp?style=flat-square" alt="MIT License" title="MIT License"></a>
2022-11-27 15:00:59 +00:00
</p>
### About
VP# is a high performance .NET wrapper for the [Virtual Paradise](https://virtualparadise.org) SDK which introduces a cleaner, more modern, and more async API.
2022-11-27 15:00:59 +00:00
*(I'm also [dogfooding](https://www.pcmag.com/encyclopedia/term/dogfooding) this library, so there's that.)*
## Installation
### NuGet installation
```ps
2024-02-17 15:29:00 +00:00
Install-Package VpSharp -Version 1.0.0
2022-11-27 15:00:59 +00:00
```
### Manual installation
Download the [latest release](https://github.com/oliverbooth/VpSharp/releases/latest) from this repository and adding a direct assembly reference for your chosen platform.
## Contributing
Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
## License
VP# is released under the MIT License. See [here](https://github.com/oliverbooth/VpSharp/blob/master/LICENSE.md) for more details.