Skip to content

chore: update README for current state and add Codecov coverage#86

Merged
LiranCohen merged 1 commit into
mainfrom
chore/readme-codecov
Feb 26, 2026
Merged

chore: update README for current state and add Codecov coverage#86
LiranCohen merged 1 commit into
mainfrom
chore/readme-codecov

Conversation

@LiranCohen

Copy link
Copy Markdown
Contributor

Summary

  • README overhaul: Updated to reflect the actual implementation state rather than the original design aspirations
  • Codecov integration: Added coverage profile generation and upload to CI

README changes

Before After
"Design phase" "Pre-release" with accurate status
did:dht references did:jwk (what we actually use)
"dexnet" networking engine "meshnet" (our actual fork)
100.64.0.x IPs 10.200.x.x (our actual CIDR)
Two protocols (wireguard-mesh + wireguard-node) Single wireguard-mesh protocol
meshd init + meshd network create quick start meshd up --create (what actually works)
Outdated project structure Accurate directory listing with all packages
No CLI reference Full CLI command listing
No protocol structure Protocol hierarchy diagram
No development instructions Build/test commands

Codecov

  • Added -coverprofile=coverage.out -covermode=atomic to the unit test step
  • Added codecov/codecov-action@v5 upload step with fail_ci_if_error: false
  • Added Codecov badge to README
  • Public repo, so tokenless upload should work (may need repo registration on codecov.io)

Verification

  • go build ./... -- zero errors
  • go vet ./... -- zero warnings
  • go test ./... -count=1 -race -coverprofile=coverage.out -- all tests pass, coverage generated

- Update README to reflect actual implementation status (pre-release,
  not design phase)
- Fix stale references: did:dht -> did:jwk, dexnet -> meshnet,
  100.64.x -> 10.200.x, two protocols -> single wireguard-mesh
- Add accurate quick start commands matching actual CLI
- Add CLI reference section, protocol structure diagram, development
  section
- Add Codecov badge and coverage upload step to CI workflow
- Set fail_ci_if_error: false so CI does not break before Codecov
  repo registration
@LiranCohen LiranCohen merged commit b286736 into main Feb 26, 2026
2 checks passed
@LiranCohen LiranCohen deleted the chore/readme-codecov branch February 26, 2026 21:19
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