Skip to content

Commit c8e51ff

Browse files
committed
docs(improv-wifi): features
1 parent a016b7d commit c8e51ff

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

crates/improv-wifi/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ miette = { version = "7.2.0", optional = true }
1919

2020
[features]
2121
miette = ["dep:miette"]
22+
networkmanager = []

crates/improv-wifi/src/lib.rs

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
11
#![cfg(target_os = "linux")]
2-
//! An implementation of [improv-wifi](https://www.improv-wifi.com) for Linux.
2+
//! An implementation of [improv-wifi] for Linux.
33
//!
44
//! This crate provides an implementation of the Improv Wi-Fi configuration protocol, as a
55
//! peripheral, via BlueZ's D-Bus API. It is intended to be used in conjunction with the
6-
//! [improv-wifi](https://www.improv-wifi.com) tooling for Web and Android, to allow for easy
7-
//! connection of an embedded Linux device to a Wi-Fi network without the need for a display or
8-
//! other input peripherals.
6+
//! [improv-wifi] tooling for Web and Android, to allow for easy connection of an embedded Linux
7+
//! device to a Wi-Fi network without the need for a display or other input peripherals.
98
//!
10-
//! As there are many different network managers available for Linux, this crate provides a trait to
11-
//! allow any network manager to be supported.
9+
//! As there are many different network systems available for Linux, this crate supplies a trait to
10+
//! allow any network configuration framework to be supported.
1211
//!
13-
//! It also bundles an implementation for [NetworkManager](https://www.networkmanager.dev) with the
14-
//! optional feature `networkmanager`.
12+
//! If you are looking for an out-of-the-box solution, you can use the `improv-wifi-cli` application
13+
//! crate, which uses this crate to provide a command-line program and systemd service.
14+
//!
15+
//! # Examples
16+
//!
17+
//! # Features
18+
//!
19+
//! - `miette`: Implements `miette::Diagnostic` on the error type.
20+
//! - `networkmanager`: Enables the `NetworkManager` wifi configurator.
21+
//!
22+
//! [improv-wifi]: https://www.improv-wifi.com
23+
//! [NetworkManager]: https://www.networkmanager.dev

0 commit comments

Comments
 (0)