Skip to content

Commit cddf844

Browse files
committed
feat: Add initial README
1 parent d3496eb commit cddf844

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Relay Android App
2+
3+
Relay is an Android app for cross-device notification and message relay, supporting a custom protocol for real-time communication with desktop clients.
4+
5+
## Features
6+
7+
- Notification mirroring from Android to desktop
8+
- Actionable notifications (reply, action buttons, dismiss)
9+
- Bidirectional protocol with length-prefixed JSON messages
10+
11+
## Getting Started
12+
13+
**Install the APK**: Download the latest APK from the [Releases page](https://github.com/SunPodder/Relay/releases) and install it on your Android device.
14+
15+
Or **Build from source**: Clone this repository and build the app using Android Studio or Gradle:
16+
```bash
17+
./gradlew assembleDebugOptimized
18+
```
19+
Then install the generated APK on your device.
20+
21+
**First-time setup:**
22+
23+
- Open the Relay app after installation.
24+
- Grant the required notification permissions when prompted.
25+
- Go to your device's App Settings for Relay → Battery optimizations → Allow unrestricted usage (to ensure background operation).
26+
- Make sure the app server is running.
27+
- You can now close the app; the Relay service will keep running in the background and forward notifications to connected clients as long as permissions are granted.
28+
29+
## Cross-Platform Desktop Client
30+
31+
A cross-platform desktop client implementation is available at:
32+
- https://github.com/SunPodder/relay-pc
33+
34+
This client supports Windows, Linux, and macOS, and is designed to work seamlessly with this Android app.
35+
36+
## Protocol
37+
38+
- All communication uses a 4-byte big-endian length-prefixed JSON envelope.
39+
- See `protocols/` for protocol details.
40+
41+
## Contributing
42+
43+
Pull requests and issues are welcome!
44+
45+
## License
46+
47+
MIT License

0 commit comments

Comments
 (0)