readme, changelog

Author: wang-bin

.gitignore

@@ -1,5 +1,13 @@
 # Miscellaneous
+.vscode/settings.json
 mdk-sdk/
+*.dll
+*.so
+*.7z
+*.apk
+*.aab
+*.xz
+*.lock
 *.class
 *.log
 *.pyc

CHANGELOG.md

@@ -1,3 +1,4 @@
 ## 0.0.1
 
-* TODO: Describe initial release.
+* video playback for windows, linux, macos, ios, android
+* hardware decoding, optimal gpu rendering

README.md

@@ -1,4 +1,4 @@
-# fvp
+# FVP
 
 [Flutter Video Player](https://pub.dev/packages/video_player) **Plugin** based on [libmdk](https://github.com/wang-bin/mdk-sdk) for all desktop and mobile platforms.
 
@@ -8,26 +8,33 @@
 - Hardware decoders are enabled by default
 - Minimal code change for existing [Video Player](https://pub.dev/packages/video_player) apps
 
-## Build
 
+## How to Use
+Add 2 lines in your video_player examples
+
+```dart
+import 'package:fvp/fvp.dart';
+
+MdkVideoPlayer.registerWith();
 ```
+
+## Build
+
+```bash
 git submodule update --init
 cd example
 flutter run
 ```
 
 Will download [libmdk](https://github.com/wang-bin/mdk-sdk) sdk if not found. You can also download the **latest** sdk for [android](https://sourceforge.net/projects/mdk-sdk/files/nightly/mdk-sdk-android.7z), [windows](https://sourceforge.net/projects/mdk-sdk/files/nightly/mdk-sdk-windows-desktop-vs2022.7z/download) and [linux](https://sourceforge.net/projects/mdk-sdk/files/nightly/mdk-sdk-linux.tar.xz) manually and extract in android, windows and linux folder. macOS and iOS will download the [latest sdk](https://sourceforge.net/projects/mdk-sdk/files/nightly/mdk-sdk-apple.zip/download) by cocoapods. To upgrade to the latest macOS/iOS sdk
-```
+
+```bash
 cd examples/macos
 pod deintegrate
 pod cache clean mdk
 pod install --verbose
 ```
 
-## How to Use
-Add 2 lines in your video_player examples
-- `import 'package:fvp/fvp.dart';`
-- `MdkVideoPlayer.registerWith();`
 ## TODO:
 - [ ] Assets
 - [ ] Android vulkan rendering
@@ -39,3 +46,9 @@ Add 2 lines in your video_player examples
 - Playback control api in dart via ffi
 - Manage video renderers in platform specific manners. Receive player ptr via `MethodChannel` to construct player instance and set a renderer target.
 - Callbacks and events in C++ are notified by ReceivePort
+
+# Screenshots
+![fpv_android](https://github.com/wang-bin/fvp/assets/785206/40f458e5-d7ca-4513-b709-b056deaaf421)
+![fvp_win](https://github.com/wang-bin/fvp/assets/785206/920bdd51-6947-4a00-87b4-9c1a21a68d51)
+![fvp_linux](https://github.com/wang-bin/fvp/assets/785206/ce2ad50b-2ead-43bb-bf25-6e2575c5ebe1)
+![fvp_macos](https://github.com/wang-bin/fvp/assets/785206/71de39a4-c5f0-4c8f-9920-d7dfc6cd0d9a)