diff --git a/README.md b/README.md new file mode 100644 index 0000000..78e2bb7 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Mac-Hardware-Info + +Mac-Hardware-Info is a companion app to [OpenBubbles](https://github.com/TaeHagen/bluebubbles-app/tree/rustpush). This application generates a unique code required for OpenBubbles to function. The code ensures that OpenBubbles can run iMessage on platforms such as Android and Windows by verifying the presence of a genuine Mac. + +## Important Notice + +- It is recomended to run Mac-Hardware-Info on a **real** mac. +- Running it on a virtual machine or other ways (e.g. a Hackintosh) may lead to problems with OpenBubbles. + +## About OpenBubbles + +OpenBubbles is based on the BlueBubbles app and allows users to utilize iMessage on non-Apple devices. For more information on OpenBubbles, check out the following links: +- [GitHub Repository](https://github.com/TaeHagen/bluebubbles-app/tree/rustpush) +- [Google Play Store](https://play.google.com/store/apps/details?id=com.openbubbles.messaging) +- [Microsoft Store](https://www.microsoft.com/store/productId/9PJMSNSQD0FV?ocid=pdpshare) + +## Getting Started + +To get started with Mac-Hardware-Info, follow these steps: + +1. Download the latest release from the [Releases page](https://github.com/TaeHagen/Mac-Hardware-Info/releases). +2. Run the downloaded application. + - macOS will alert you that the app is from an unverified developer. Make sure to allow it to run. (Don't worry, the code is safe.) +3. Follow the on-screen instructions to generate your unique code. +4. You can either: + - Scan the QR code from OpenBubbles. + - Copy the code and input it into OpenBubbles. + +## Contact + +For any questions or support, please open an issue on the [GitHub repository](https://github.com/TaeHagen/Mac-Hardware-Info/issues) or contact [TaeHagen on discord](https://discord.com/users/345288899813179394). +