diff --git a/README.md b/README.md new file mode 100644 index 0000000..3f12a49 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# idevice + +A Rust library for interacting with iOS services. +Inspired by [libimobiledevice](https://github.com/libimobiledevice/libimobiledevice) +and [pymobiledevice3](https://github.com/doronz88/pymobiledevice3), +this library interfaces with lockdownd and usbmuxd to perform actions +on an iOS device that a Mac normally would. + +## State + +This library is in development and research stage. +Releases are being published to crates.io for use in other projects, +but the API and feature-set are far from final or even planned. + +- [x] lockdownd connection +- [x] SSL support +- [x] Heartbeat +- [x] Pairing file +- [ ] Instproxy (partial support) +- [ ] afc +- [ ] amfi +- [ ] companion proxy +- [ ] diagnostics +- [ ] file relay +- [ ] house arrest +- [ ] misagent (certificates) +- [ ] RemoteXPC + - Debug server + - Image mounting +- [ ] mobile backup +- [ ] notification proxy +- [ ] screenshot +- [ ] simulate location +- [ ] web inspector +- [ ] usbmuxd connection +- [ ] Documentation + +As this project is done in my free time within my busy schedule, there +is no ETA for any of these. Feel free to contribute or donate! + +## Version Policy + +As Apple prohibits downgrading to older versions, this library will +not keep compatibility for older versions than the current stable release. + +## License + +MIT