diff --git a/docs/docs/getting-started/flutter-setup.md b/docs/docs/getting-started/flutter-setup.md new file mode 100644 index 00000000..620641bb --- /dev/null +++ b/docs/docs/getting-started/flutter-setup.md @@ -0,0 +1,35 @@ +# Flutter Setup + +After completing the [Rust setup](rust-setup.md) and setting up either [iOS setup](ios-setup.md) or [Android setup](android-setup.md), you're ready to create a cross-platform project using [Flutter](https://flutter.dev/).
+Flutter is a framework for building natively compiled, multi-platform applications from a single codebase. + +## Flutter plugin example + +You can now clone the repository from [zkmopro/flutter-plugin](https://github.com/zkmopro/flutter-plugin) with + +```sh +git clone https://github.com/zkmopro/flutter-plugin +``` + +Once cloned, follow the instructions in the README file to run the example app for the plugin. + +
+ First Image + Second Image +
+ +## Use the flutter plugin + +To use the plugin, update your `pubspec.yaml` file by adding the following dependency: + +```yml +dependencies: + mopro_flutter: + # When depending on this package from a real application you should use: + # mopro_flutter: ^x.y.z + # See https://dart.dev/tools/pub/dependencies#version-constraints + # The example app is bundled with the plugin so we use a path dependency on + # the parent directory to use the current plugin's version. + path: + # e.g. path: ../flutter-plugin +``` \ No newline at end of file diff --git a/docs/sidebars.ts b/docs/sidebars.ts index 7c5ead4b..448b3e27 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -19,7 +19,8 @@ const sidebars: SidebarsConfig = { 'getting-started/rust-setup', 'getting-started/ios-setup', 'getting-started/android-setup', - 'getting-started/react-native-setup' + 'getting-started/react-native-setup', + 'getting-started/flutter-setup' ] }, { diff --git a/docs/static/img/flutter-android.png b/docs/static/img/flutter-android.png new file mode 100644 index 00000000..1e42715e Binary files /dev/null and b/docs/static/img/flutter-android.png differ diff --git a/docs/static/img/flutter-ios.png b/docs/static/img/flutter-ios.png new file mode 100644 index 00000000..bde646ef Binary files /dev/null and b/docs/static/img/flutter-ios.png differ diff --git a/docs/versioned_docs/version-0.1.0/getting-started/flutter-setup.md b/docs/versioned_docs/version-0.1.0/getting-started/flutter-setup.md new file mode 100644 index 00000000..620641bb --- /dev/null +++ b/docs/versioned_docs/version-0.1.0/getting-started/flutter-setup.md @@ -0,0 +1,35 @@ +# Flutter Setup + +After completing the [Rust setup](rust-setup.md) and setting up either [iOS setup](ios-setup.md) or [Android setup](android-setup.md), you're ready to create a cross-platform project using [Flutter](https://flutter.dev/).
+Flutter is a framework for building natively compiled, multi-platform applications from a single codebase. + +## Flutter plugin example + +You can now clone the repository from [zkmopro/flutter-plugin](https://github.com/zkmopro/flutter-plugin) with + +```sh +git clone https://github.com/zkmopro/flutter-plugin +``` + +Once cloned, follow the instructions in the README file to run the example app for the plugin. + +
+ First Image + Second Image +
+ +## Use the flutter plugin + +To use the plugin, update your `pubspec.yaml` file by adding the following dependency: + +```yml +dependencies: + mopro_flutter: + # When depending on this package from a real application you should use: + # mopro_flutter: ^x.y.z + # See https://dart.dev/tools/pub/dependencies#version-constraints + # The example app is bundled with the plugin so we use a path dependency on + # the parent directory to use the current plugin's version. + path: + # e.g. path: ../flutter-plugin +``` \ No newline at end of file diff --git a/docs/versioned_sidebars/version-0.1.0-sidebars.json b/docs/versioned_sidebars/version-0.1.0-sidebars.json index 78c2579f..229dd649 100644 --- a/docs/versioned_sidebars/version-0.1.0-sidebars.json +++ b/docs/versioned_sidebars/version-0.1.0-sidebars.json @@ -17,7 +17,8 @@ "getting-started/rust-setup", "getting-started/ios-setup", "getting-started/android-setup", - "getting-started/react-native-setup" + "getting-started/react-native-setup", + "getting-started/flutter-setup" ] }, {