VpSharp/README.md

27 lines
1.4 KiB
Markdown

<h1 align="center"><img src="banner.png"></h1>
<p align="center">
<a href="https://github.com/oliverbooth/VpSharp/actions?query=workflow%3A%22.NET%22"><img src="https://img.shields.io/github/workflow/status/oliverbooth/VpSharp/.NET" 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" alt="GitHub Issues" title="GitHub Issues"></a>
<a href="https://github.com/oliverbooth/VpSharp/blob/master/LICENSE.md"><img src="https://img.shields.io/github/license/oliverbooth/VpSharp" alt="MIT License" title="MIT License"></a>
</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.
*(I'm also [dogfooding](https://www.pcmag.com/encyclopedia/term/dogfooding) this library, so there's that.)*
## Installation
### NuGet installation
```ps
Install-Package VpSharp -Version 0.1.0
```
### 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.