Skip to content

Rewrite README intro, add badges, fix broken support link - #2613

Open
Fightersbane wants to merge 1 commit into
devfrom
ls/readme-refresh
Open

Rewrite README intro, add badges, fix broken support link#2613
Fightersbane wants to merge 1 commit into
devfrom
ls/readme-refresh

Conversation

@Fightersbane

@Fightersbane Fightersbane commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Refreshes the top-level README: updated intro copy, a header badge block, and two link/typo fixes.

Broken link

https://www.zerotier.com/contact (linked as "Commercial Support") returns 404 — with and without a trailing slash, so it isn't a redirect issue. Repointed at https://docs.zerotier.com/support/, which is where the marketing www.zerotier.com/support/ landing page sends people anyway. Using the trailing-slash form directly, since docs.zerotier.com/support 301s to it.

The other five links were verified fine: docs, corporate site, downloads, service/README.md, nonfree/controller/README.md.

Typo

License section: node/, osdep/. service/, -> node/, osdep/, service/,

Copy

The About section is rewritten to describe ZeroTier One as identity-first SDN for distributed infrastructure, split into About / How It Works / Security. The platform note and the build.md pointer move into their own Platforms and Building and Running sections so About isn't carrying housekeeping. build.md is now a real link.

Badges

Centered header block using the existing artwork/ZeroTierIcon512x512.png, plus:

  • build.yml and validate.yml Actions status — both passing at time of writing. These reference workflow file paths, since neither workflow declares a name:.
  • Latest release — resolves to v1.16.2, matching version.h.
  • License — MPL-2.0 + source-available rather than a plain MPL badge, since nonfree/ isn't MPL. Links to the License section.
  • Docs, and a static platforms badge (checked against the make-*.mk files, windows/, and java/).

Every link and badge URL in the new README was verified to return 200 and all relative paths resolve.

Deliberately left out a GitHub downloads-total badge — it reads ~230, since real distribution goes through zerotier.com, so it undersells things badly.

Note

The Platforms section adds one sentence not in the source copy — "ZeroTier One runs on Linux, macOS, Windows, and BSD." — so the section covers desktop and not just the mobile apps. Easy to drop.

🤖 Generated with Claude Code

Replace the About section with updated copy describing ZeroTier One as
identity-first SDN, split across About / How It Works / Security, and
move the platform and build notes into their own sections.

Add a centered header block with the existing repo icon and badges for
build and validate workflow status, latest release, license, docs, and
supported platforms.

Point "Commercial Support" at https://docs.zerotier.com/support/ — the
old https://www.zerotier.com/contact URL returns 404. Also fix a stray
period in the license section ("osdep/. service/" -> "osdep/, service/").

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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