1
0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-14 05:55:42 +00:00
X10D/README.md

3.3 KiB

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

About

X10D (pronounced extend), is a .NET package that provides extension methods for numerous types. The purpose of this library is to simplify a codebase by reducing the need for repeated code when performing common operations. Simplify your codebase. Take advantage of .NET. Use extension methods.

(I'm also dogfooding this library, so there's that.)

Installation

NuGet installation

Install-Package X10D -Version 3.0.0

Manual installation

Download the latest release from this repository and adding a direct assembly reference for your chosen platform.

Unity installation

Starting with Unity 2021.2, support for .NET Standard 2.1 has been added. With this change, I am confident providing support for this version for the time being, with only minimal feature-loss. To add X10D into your Unity project, goto the Package Manager window, and choose to install from a Git URL, and use the URL https://github.com/oliverbooth/X10D.git#upm

Parity with the main branch of X10D, and full .NET 6 feature support, is planned - but a timeline is not yet available. Unity plan to add .NET 6 support in the near future. For more information, see this forum post.

Features

I'm planning on writing complete and extensive documentation in the near future. As of this time, feel free to browse the source or the API using your favourite IDE. For those familiar with the 2.6.0 API, please read CHANGELOG.md for a complete list of changes. 3.0.0 is a major release and introduces many breaking changes.

Contributing

Contributions are welcome. See CONTRIBUTING.md.

License

X10D is released under the MIT License. See here for more details.