Merge branch 'master' of https://github.com/huynguyennovem/netshare

Author: huynguyennovem

README.md

@@ -1,7 +1,7 @@
 # NetShare
 Data sharing in local network
 
-<img width="772" alt="Screenshot 2023-01-11 at 21 39 25" src="https://user-images.githubusercontent.com/29337364/211834507-cd29722b-53ce-40f0-9ef5-350138406773.png">
+<img width="772" alt="Screenshot 2023-01-11 at 21 39 25" src="https://github.com/huynguyennovem/netshare/assets/29337364/0a4ab95b-1fd8-4f30-97f2-43e3805894f2">
 
 [![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/blueaquilae.svg?style=social&label=Follow%20HuyNguyenTw)](https://twitter.com/HuyNguyenTw)
 
@@ -24,27 +24,43 @@ https://github.com/huynguyennovem/netshare/assets/29337364/2e9caa89-d05a-48f5-ae
 ## How to build the project
 _Note: This project is mainly running on the latest Flutter beta channel_
 
-1. Run Hive object generator (if needed)
-The project's using (hive)[https://pub.dev/packages/hive] (NoSQL Database) to cache object data. Before running this, we should generate all entities adapters (being inside `.g.dart` files) to make sure all they are updated:
+1. Run the project as usual
 
 ```bash
-flutter pub run build_runner build --delete-conflicting-outputs
+flutter run -d <target-platforms>
 ```
 
-2. Run the project as usual
+`<target-platforms>` is all supported Flutter platforms, except Web.
 
-```bash
-flutter run
-```
 
 Normally, desktop app (macOS, Windows, Linux) will be server and mobile app (Android, iOS) will be client role. But roles can be reversed, let's try and enjoy :) 
 
+## How to use the app
+
+1. Build and open app on your target platform as above
+
+For instance, I want to share files between Macbook and Android, so I will build and run app for these platforms. Or you can use released binary files in [Releases](https://github.com/huynguyennovem/netshare/releases) without building the project.
+
+2. Connect
+
+- On Macbook (assume the role of server):
+    - Enter the current machine's IP address and port (In 1st time, it will automatically get IP and auto-filled it. Next time, it will use the cached previous connected address).
+    - Enter/paste/pick directory location where the files will be hosted.
+    - Click on `Start hosting` button
+- On Android/iOS (assume the role of client):
+    - You have two options:
+      - `Scan to connect` to scan the address with QR Code generated by server app (on Mac above)
+      - `Manual connect` to enter address yourself
+    - After filling IP/port, press `Connect` button and enjoy it 
+
 **Note**
 - Remember to connect both server and client app in the same network
 - iOS:
 To keep iOS app persisting on your device, recommend running it in release mode: `flutter run --release` (you can not reopen app if running it in debug mode)
-
-
+- Run Hive object generator (only when [hive](https://pub.dev/packages/hive) (NoSQL Database) has some major changes or the project lacks `.g.dart` files). By default, all `.g.dart` files are committed to the repository so you don't need to re-generate again. 
+```bash
+flutter pub run build_runner build --delete-conflicting-outputs
+```