diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9661b4e..0e318c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,9 +53,9 @@ This setup live-reloads the site and forwards `/api/*` requests to the emulator. - for code changes, Use commit messages with tags, e.g.: - - `fix(server): handle large file uploads` - - `feat(main): add new button` - - `tests: add tests for upload endpoint` + - `fix(server): improve error handling for large file uploads` + - `feat(ui): add progress indicator for file transfers` + - `perf(server): optimize streaming for multi-GB files` - Fork the repo and create a branch for your change. - Open a pull request diff --git a/README.md b/README.md index 7100dd3..965fd76 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,74 @@ -# Transfer - -A simple local file server app for Android. Download and upload files quickly across devices over Wi-Fi — no cables, no cloud. - -
-
-
-
-
-
-
- |
-
+A simple local file server for Android
-#### Other ways -Directly from [github releases](https://github.com/matan-h/Transfer/releases) (and you can also point Obtainium to this link.) ++ Transfer files instantly across devices over Wi-Fi – no cables, no cloud, no hassle. +
-## Getting Started +## Screenshots -1. Install and open Transfer on your Android device. -2. Grant necessary permissions and select a folder you wish to share (suggestion: create a new folder called `Storage` in your home directory). -3. Tap "Start Server." -4. The app will display an IP address (e.g., `http://192.168.1.X:8000`). -5. Open this address in a web browser on any other device connected to the same Wi-Fi network. -6. You're in! If IP permissions are on (default), you'll get a prompt on your phone to allow the new device. +
+
+
+
+
+
+
+