[ci skip] Remove table of contents, add upm branch notice

This commit is contained in:
Oliver Booth 2022-04-30 14:57:20 +01:00
parent 3a118e1890
commit d99987d5d8
No known key found for this signature in database
GPG Key ID: 32A00B35503AF634
1 changed files with 2 additions and 8 deletions

View File

@ -14,14 +14,6 @@ X10D (pronounced *extend*), is a .NET package that provides extension methods fo
*(I'm also [dogfooding](https://www.pcmag.com/encyclopedia/term/dogfooding) this library, so there's that.)* *(I'm also [dogfooding](https://www.pcmag.com/encyclopedia/term/dogfooding) this library, so there's that.)*
### Table of contents
- [Installation](#installation)
- [Unity installation](#unity-installation)
- [NuGet installation](#nuget-installation)
- [Features](#features)
- [Contributing](#contributing)
- [License](#license)
## Installation ## Installation
### NuGet installation ### NuGet installation
```ps ```ps
@ -36,6 +28,8 @@ I decided it was time for X10D to be migrated to .NET 6. Unity currently support
Unity have announced official support for .NET 6 in the future (see [this forum post](https://forum.unity.com/threads/unity-future-net-development-status.1092205/) for more details), Unity have announced official support for .NET 6 in the future (see [this forum post](https://forum.unity.com/threads/unity-future-net-development-status.1092205/) for more details),
but until such a time that Unity supports .NET 6, X10D.Unity will not be maintained or innovated upon. but until such a time that Unity supports .NET 6, X10D.Unity will not be maintained or innovated upon.
The upm branch, however, is still available under version 2.6.0 - if you wish to use this version, add the package https://github.com/oliverbooth/X10D.git#upm to your Unity project.
## Features ## 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. 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](CHANGELOG.md) for a complete list of changes. **3.0.0 is a major release and introduces many breaking changes.** For those familiar with the 2.6.0 API, please read [CHANGELOG.md](CHANGELOG.md) for a complete list of changes. **3.0.0 is a major release and introduces many breaking changes.**