From e9c416caa554fcac10a4105466bce119eb4196ad Mon Sep 17 00:00:00 2001 From: nab138 Date: Sat, 14 Feb 2026 15:28:58 -0500 Subject: [PATCH] Update example and README --- README.md | 6 ++++++ examples/minimal/README.md | 5 +++++ examples/minimal/src/main.rs | 8 ++------ 3 files changed, 13 insertions(+), 6 deletions(-) create mode 100644 examples/minimal/README.md diff --git a/README.md b/README.md index c07ad76..6fff413 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,12 @@ A Rust library for sideloading iOS applications using an Apple ID. Used in [Cros This branch is home to isideload-next, the next major version of isideload. It features a redesigned API, improved error handling, better entitlement handling, and more. It is not ready! +## Usage + +**You must call `isideload::init()` at the start of your program to ensure that errors are properly reported.** If you don't, errors related to network requests will not show any details. + +A full usage example is available is in [examples/minimal](examples/minimal/). + ## TODO Things left todo before the rewrite is considered finished diff --git a/examples/minimal/README.md b/examples/minimal/README.md new file mode 100644 index 0000000..6a6f7f9 --- /dev/null +++ b/examples/minimal/README.md @@ -0,0 +1,5 @@ +# minimal + +A minimal sideloading CLI to to demonstrate isideload. + +Usage: `minimal ` \ No newline at end of file diff --git a/examples/minimal/src/main.rs b/examples/minimal/src/main.rs index 6abc19a..ec50000 100644 --- a/examples/minimal/src/main.rs +++ b/examples/minimal/src/main.rs @@ -46,11 +46,6 @@ async fn main() { .login(apple_password, get_2fa_code) .await; - // match &account { - // Ok(a) => println!("Logged in. {}", a), - // Err(e) => panic!("Failed to log in to Apple ID: {:?}", e), - // } - let mut account = account.unwrap(); let dev_session = DeveloperSession::from_account(&mut account) @@ -68,7 +63,8 @@ async fn main() { panic!("No devices found"); } - let provider = devs.first() + let provider = devs + .first() .unwrap() .to_provider(UsbmuxdAddr::from_env_var().unwrap(), "isideload-demo");