Fluxer.Net 1.7.0

Fluxer.Net

Fluxer.Net is currently functional with Fluxer's pre-release, however, things are very likely to break or stop working as Fluxer updates. Please report bug reports in the issues page, and open pull requests for missing or broken features and endpoints.

<br />

<div align="center"> <a href="https://www.nuget.org/packages/Fluxer.Net/"> <img src="https://img.shields.io/nuget/v/Fluxer.Net.svg?maxAge=2592000?style=plastic" alt="NuGet"> </a> <a href="https://www.nuget.org/packages/Fluxer.Net/"> <img src="https://img.shields.io/nuget/vpre/Fluxer.Net.svg?maxAge=2592000?style=plastic" alt="NuGet"> </a> <a href="https://github.com/Nexfinity/Fluxer.Net/actions/workflows/publish.yml"> <img src="https://github.com/Nexfinity/Fluxer.Net/actions/workflows/publish.yml/badge.svg" alt="Dotnet Build Status"> </a> </div>

📄 Documentation

Documentation can be found at https://fluxer.net/

🩷 Supporting Fluxer.Net

Fluxer.Net is an MIT-licensed open source project with its development made possible entirely by volunteers.

📥 Installation

Stable (NuGet)

Our stable builds available from NuGet through the Fluxer.Net metapackage:

• Fluxer.Net

Nightlies

Nightlies are builds of Fluxer.Net that are still in an experimental phase, and have not been released. We do not current have a nightlies build feed.

🗃️ Versioning Guarantees

Patch component

An increment of the PATCH component always indicates that an internal-only change was made, generally a bugfix. These changes will not affect the public-facing API in any way, and are always guaranteed to be forward- and backwards-compatible with your codebase, any pre-compiled dependencies of your codebase.

Minor component

An increment of the MINOR component indicates that some addition was made to the library, and this addition is not backwards-compatible with prior versions. However, Fluxer.Net does not guarantee forward-compatibility on minor additions. In other words, we permit a limited set of breaking changes on a minor version bump.

Major version bumps generally indicate some major change to the library, and as such we are hesitant to bump the major version for every minor addition to the library.

While we will never break the API (outside of interface changes) on minor builds, we will occasionally need to break the ABI, by introducing parameters to a method to match changes upstream with Fluxer. As such, a minor version increment may require you to recompile your code, and dependencies, such as addons, may also need to be recompiled and republished on the newer version. When a binary breaking change is made, the change will be noted in the release notes.

Major component

An increment of the MAJOR component indicates that breaking changes have been made to the library; consumers should check the release notes to determine what changes need to be made.

📚 Branches

Release

Release branch. Upon release, patches will be pushed to these branches. New NuGet releases will be tagged on this branch.

Dev

Development branch, available on MyGet. This branch is what pull requests are targetted to.

Feature/X

Branches that target Dev, adding new features. Feel free to explore these branches and give feedback where necessary.