|
1 | 1 | #![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. |
3 | 3 | //!
|
4 | 4 | //! This crate provides an implementation of the Improv Wi-Fi configuration protocol, as a
|
5 | 5 | //! 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. |
9 | 8 | //!
|
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. |
12 | 11 | //!
|
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