diff --git a/README.md b/README.md index 522d4c0..19fdb28 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ -# ISODroid +# ISO Drive -Android App for isodrive cli tool https://github.com/nitanmarcel/isodrive \ No newline at end of file +Android app for mounting ISO/IMG files as USB mass storage or CD-ROM devices on rooted Android devices. + +## Features + +- Mount ISO/IMG files as USB mass storage or CD-ROM +- Read-only or read-write mount options +- Persistent notification with quick unmount button +- Browse and select ISO files from device storage +- Download links to popular operating systems (Linux, BSD, Windows, Recovery tools) +- Material 3 dynamic theming + +## Requirements + +- Rooted Android device (Magisk, KernelSU, APatch, etc.) +- USB gadget support (configfs or sysfs) +- Android 8.0+ (API 26) + +## Installation + +1. Install the [isodrive](https://github.com/nitanmarcel/isodrive) binary via the [Magisk module](https://github.com/nitanmarcel/isodrive-magisk/releases/latest) or manually +2. Install the ISO Drive APK +3. Grant root access when prompted +4. Place your ISO/IMG files in `/sdcard/isodrive/` (or configure a different directory in settings) + +## Usage + +1. Open ISO Drive +2. Select an ISO/IMG file from the list +3. Choose mount options (Mass Storage or CD-ROM, Read-Only or Read-Write) +4. Tap Mount +5. Connect your phone to a PC via USB - it will appear as a USB drive +6. Unmount via the app or notification when done + +## Credits + +- [isodrive](https://github.com/nitanmarcel/isodrive) by nitanmarcel - The CLI tool that powers ISO Drive +- [ISODriveUT](https://github.com/fredldotme/ISODriveUT) by fredldotme - Original inspiration for isodrive +- OS icons from [Simple Icons](https://simpleicons.org/) + +## License + +MIT