Skip to content

Commit

Permalink
add Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pythops committed Jun 9, 2024
1 parent 7f10215 commit f57d725
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# iwdrs - Rust bindings for iwd

## Implemented (fully or partially) APIs

- [adapter](https://git.kernel.org/pub/scm/network/wireless/iwd.git/tree/doc/adapter-api.txt)
- [agent](https://git.kernel.org/pub/scm/network/wireless/iwd.git/tree/doc/agent-api.txt)
- [device](https://git.kernel.org/pub/scm/network/wireless/iwd.git/tree/doc/device-api.txt)
- [knownnetwork](https://git.kernel.org/pub/scm/network/wireless/iwd.git/tree/doc/knownnetwork-api.txt)
- [network](https://git.kernel.org/pub/scm/network/wireless/iwd.git/tree/doc/network-api.txt)
- [station](https://git.kernel.org/pub/scm/network/wireless/iwd.git/tree/doc/station-api.txt)

## Getting started

Add the following to your `cargo.toml`

```
[dependencies]
iwdrs = 0.1
```

## TODO

- Implement the rest of the APIs
- Add documentation
- Add tests

## Resources

- [iwd dbus api](https://git.kernel.org/pub/scm/network/wireless/iwd.git/tree/doc)

## License

LGPL-2.1

0 comments on commit f57d725

Please sign in to comment.