Skip to content

Commit 96da4fa

Browse files
committed
Remove publishability docs and add CI badges
Delete transitional planning docs (PUBLISHABILITY_ROADMAP.md and docs/API.md), tidy Cargo.toml excludes (remove roadmap, add AGENTS.md), and update documentation. Add crates.io/docs.rs/CI badges to README, remove the API.md link from docs/README.md, and add a CI Coverage section to docs/TESTING.md documenting the CI jobs and feature-matrix checks.
1 parent c883482 commit 96da4fa

6 files changed

Lines changed: 22 additions & 476 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ exclude = [
2020
"target/",
2121
"apps/",
2222
"xtask/",
23+
"AGENTS.md",
2324
"CLAUDE.md",
24-
"PUBLISHABILITY_ROADMAP.md",
2525
"Cargo.toml.orig",
2626
]
2727

PUBLISHABILITY_ROADMAP.md

Lines changed: 0 additions & 191 deletions
This file was deleted.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# ph-esp32-mac
22

3+
[![Crates.io](https://img.shields.io/crates/v/ph-esp32-mac.svg)](https://crates.io/crates/ph-esp32-mac)
4+
[![Docs.rs](https://docs.rs/ph-esp32-mac/badge.svg)](https://docs.rs/ph-esp32-mac)
5+
[![CI](https://github.com/photon-circus/ph-esp32-mac/actions/workflows/ci.yml/badge.svg)](https://github.com/photon-circus/ph-esp32-mac/actions/workflows/ci.yml)
6+
37
`ph-esp32-mac` is a `no_std`, `no_alloc` Rust driver for the ESP32 Ethernet MAC (EMAC). It targets ESP32 hardware, provides LAN8720A PHY support, and integrates with smoltcp, embassy-net, and esp-hal.
48

59
---

0 commit comments

Comments
 (0)