Skip to content

docs: packages as a list + prerelease NuGet badges#191

Merged
gralin merged 10 commits into
masterfrom
readme-packages-list
Jul 3, 2026
Merged

docs: packages as a list + prerelease NuGet badges#191
gralin merged 10 commits into
masterfrom
readme-packages-list

Conversation

@gralin

@gralin gralin commented Jul 3, 2026

Copy link
Copy Markdown
Member
  • Packages section is now a list instead of a two-column table — GitHub can't widen the narrow badge column, and the list reads well on both GitHub and nuget.org.
  • NuGet badges switched from nuget/v (stable only) to nuget/vpre, so they show the latest version including prereleases4.0.0-beta.1 now, and the highest version once 4.0.0 ships.

gralin added 10 commits July 3, 2026 07:55
Replace the two-column Packages table (GitHub can't widen the narrow badge column)
with a list, and switch the NuGet badges from nuget/v (stable only) to nuget/vpre so
they show the latest version including prereleases (4.0.0-beta.1 now).
Reference logo.png via its raw.githubusercontent.com URL so it renders on both the
GitHub repo page and the NuGet package readme (relative paths don't resolve on nuget.org).
The snippet compiles and runs (verified against the built library), but it only does
Who-Is, not 'read a property' as the intro claimed. Also note that on a multi-interface
host the transport needs localEndpointIp, or it throws a clear error listing candidates.
On a host with several network interfaces, BacnetIpUdpProtocolTransport no longer guesses
one silently — Start() now throws and lists the candidates unless localEndpointIp is given.
Add this to the README upgrade list and MIGRATION.md.
… & history

- Lead with what BACnet is (ASHRAE 135 building-automation protocol) for newcomers.
- Add a Features section (verified against the public API): transports, client/device
  roles, discovery, read/write, COV, alarms/events, more services, segmentation, ASN.1.
- Move the fork/authorship history to a Credits & history section near the bottom, and
  link Jakub Bartkowiak (github.com/gralin) and Ela-compil (ela.pl).
"BACnet" and the BACnet logo are registered trademarks of ASHRAE. Add a Trademarks
section clarifying this is an independent implementation not affiliated with or endorsed
by ASHRAE or BACnet International.
@gralin gralin merged commit 4148592 into master Jul 3, 2026
4 checks passed
@gralin gralin deleted the readme-packages-list branch July 3, 2026 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant