talksik/wifi-rs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

--amend

Browse Source
This commit is contained in:
Tochukwu Nkemdilim
2019-12-12 10:40:52 +01:00
parent b0d3887ab6
commit 1819ee30d0
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -8
View File
@@ -2,12 +2,13 @@
A rust crate to interface and manage Wi-Fi networks.
## How it works
This is a command-line counterpart of managing networks using a GUI client.
- The command creates a new connection and then activates it on a device.
- This is a command-line counterpart of clicking an SSID in a GUI client.
- The command always creates a new connection and thus it is mainly useful for connecting to new Wi-Fi networks.
- If a connection for the network already exists, it is better to bring up (activate) the existing connection as follows: `WiFi::connection_up("SSID")`.
## Features
- Allows connecting to a WiFi (Windows, Linux, MacOS).
- Allows disconnect from a WiFi network (Windows, Linux, MacOS).
- Allows creating hotspot (All except MacOS).
## Currently supported network types
@@ -51,7 +52,7 @@ fn main() -> Result<(), WifiConnectionError> {
}
```
## Features
## Todos
### Windows
@@ -73,8 +74,8 @@ fn main() -> Result<(), WifiConnectionError> {
### MacOS
- [x] Add support for MacOS.
- [ ] Add get network type feature.
- [ ] Add hotspot functionality.
- [ ] Add get network type feature.
### General
@@ -84,7 +85,7 @@ fn main() -> Result<(), WifiConnectionError> {
## Contribution
Any feature you feel is missing, why not send in a Pull Request, and let's help make this project better. Or are there any bugs, kindly create an issue, so we could work towards fixing it.
Any feature you feel is missing, why not send in a Pull Request, and let's help make this project better. Or are there any bugs, kindly create an issue, so we could work together towards fixing it.
## Support