Add README

README.md

@@ -0,0 +1,47 @@
+# Android Call & SMS Forwarder App
+
+This Android application captures incoming calls and SMS messages, and forwards the data to a Bark server. You can receive notifications on other devices using the Bark app.
+
+## Features
+- Capture incoming calls and SMS messages.
+- Forward call and SMS information to a Bark server.
+- Receive notifications on other devices using the Bark app.
+
+## Prerequisites
+1. **Bark Server Setup**: Set up your Bark server by following the instructions provided in the [Bark Server GitHub repository](https://github.com/Finb/bark-server/blob/master/README.md).
+
+2. You can also use the [Bark public server](https://bark.day.app/) if you don't want to setup your own. But it's not recommendation considering privacy.
+
+## Installation Instructions
+1. **Download the App**
+   - Navigate to the [Releases](https://github.com/jinweijie/notify-me/releases) section of this repository.
+   - Download the latest version of the APK.
+
+2. **Install the App**
+   - Transfer the APK file to your Android device.
+   - Install the APK by opening the file and following the on-screen prompts.
+
+3. **App Permissions**
+   - After installation, make sure to grant the following permissions:
+     - **SMS**: To capture incoming SMS messages.
+     - **Phone Calls**: To capture incoming call details.
+     - **Autostart**: Enable the app to start automatically when the phone reboots.
+
+## Setup Instructions
+1. **Configure Bark Server URL**
+   - Open the app and configure the Bark server URL to forward incoming messages.
+   - You can obtain the base URL from your Bark server setup (e.g., `http://your-bark-server-url/...`).
+
+## Usage
+- Once installed and configured, the app will run in the background.
+- It will capture incoming calls and SMS messages and automatically forward them to the Bark server.
+- Notifications will be sent to devices that have the Bark app installed.
+
+## Notes
+- Ensure the app is not restricted by battery optimization settings to allow continuous background operation.
+- Make sure that the Bark server is set up and running properly to receive notifications.
+
+## Troubleshooting
+- If the app stops forwarding messages, ensure it has all necessary permissions and is allowed to run in the background.
+- Check the Bark server setup to ensure it's correctly configured to accept forwarded messages.
+