From cabc3d0dd74897aa2205347b7501e59e72244f8f Mon Sep 17 00:00:00 2001 From: Frostie314159 Date: Wed, 11 Dec 2024 15:19:23 +0100 Subject: [PATCH] Adjusted README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f951ed..c39d3da 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ This repo contains an experimental port of esp32-open-mac to Rust, with embassy. ## DISCLAIMER This is experimental software. USE AT YOUR OWN RISK! We'll not take any liability for damage to the hardware. We do not condone the use of this for malicious purposes. ## Usage -The crate is a library and there are example binaries in `src/bin/`. The only public API is the `WiFi` struct, which provides all currently implemented functioniality. Currently the RX policy is fixed to three, which means only beacons will be received. +The actual crate lives in `esp32-wifi-hal-rs/` and examples are in `examples/`. + +For further information see the docs. ## Building To set up a development environment follow the guide at https://docs.esp-rs.org/book/installation/index.html. Since this only works on the ESP32 right now, only the Xtensa section is of interest. To try one of these examples: