Merge pull request #68 from osociety/bug-fixes

Bug fixes

Author: git-elliot

.github/workflows/flutter.yml

@@ -39,7 +39,7 @@ jobs:
         run: flutter --version
 
       - name: Cache pubspec dependencies
-        uses: actions/cache@v4.1.2
+        uses: actions/cache@v4.2.4
         with:
           path: |
             ${{ env.FLUTTER_HOME }}/.pub-cache
@@ -51,18 +51,6 @@ jobs:
           restore-keys: |
             build-pubspec-
 
-      - name: Cache build runner
-        uses: actions/cache@v4.1.2
-        with:
-          path: |
-            **/.dart_tool
-            **/*.g.dart
-            **/*.mocks.dart
-            **/*.config.dart
-          key: build-runner-${{ hashFiles('**/asset_graph.json', '**/*.dart', '**/pubspec.lock', '**/outputs.json') }}
-          restore-keys: |
-            build-runner-
-
       - name: Download pub dependencies
         run: flutter pub get
 

.github/workflows/publish.yml

@@ -39,7 +39,6 @@ jobs:
     needs: 'test'
     permissions:
       id-token: write # Required for authentication using OIDC
-    uses: git-elliot/setup-dart/.github/workflows/flutter_publish.yml@main # Added build_runner step
+    uses: dart-lang/setup-dart/.github/workflows/publish.yml@v1
     with:
-      environment: 'pub.dev'
-      build_runner: true
+      environment: 'pub.dev'

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 3.0.0
+Performance improvements
+
 ## 2.0.5
 Bug fixes and improvements
 

README.md

@@ -28,7 +28,12 @@ And initialize the pacakge in the main function
  await configureNetworkToolsFlutter((await getApplicationDocumentsDirectory()).path);
 ```
 
-From here please follow the documentation of [network_tools](https://pub.dev/packages/network_tools) as they are the same. 
+
+## Example
+
+See the [example](example/) directory for a complete Flutter app using this package.
+
+From here please follow the documentation of [network_tools](https://pub.dev/packages/network_tools) as they are the same.
 
 
 ## mDNS search

example/.gitignore

@@ -1,13 +1,20 @@
+# Ignore all generated plugin registrant and plugins files across platforms
+**/flutter/generated_plugin_registrant.*
+**/flutter/generated_plugins.*
+**/Flutter/GeneratedPluginRegistrant.*
+
 # Miscellaneous
 *.class
 *.log
 *.pyc
 *.swp
 .DS_Store
 .atom/
+.build/
 .buildlog/
 .history
 .svn/
+.swiftpm/
 migrate_working_dir/
 
 # IntelliJ related
@@ -31,6 +38,7 @@ migrate_working_dir/
 .pub-cache/
 .pub/
 /build/
+/pubspec.lock
 
 # Symbolication related
 app.*.symbols

example/README.md

@@ -1,16 +1,18 @@
-# example
-
-A new Flutter project.
+samples, guidance on mobile development, and a full API reference.
 
-## Getting Started
+# Example for network_tools_flutter
 
-This project is a starting point for a Flutter application.
+This example demonstrates how to use the `network_tools_flutter` package in a Flutter app.
 
-A few resources to get you started if this is your first Flutter project:
+```dart
+import 'package:network_tools_flutter/network_tools_flutter.dart';
+import 'package:path_provider/path_provider.dart';
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+Future<void> main() async {
+	final appDocDirectory = await getApplicationDocumentsDirectory();
+	await configureNetworkToolsFlutter(appDocDirectory.path, enableDebugging: true);
+	// Now you can use the network_tools_flutter APIs
+}
+```
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+For a complete example, see the code in this directory.

example/android/app/build.gradle

@@ -28,12 +28,12 @@ android {
     ndkVersion flutter.ndkVersion
 
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
     }
 
     kotlinOptions {
-        jvmTarget = '1.8'
+        jvmTarget = '17'
     }
 
     sourceSets {
@@ -45,7 +45,7 @@ android {
         applicationId "org.fsociety.network_tools_flutter_example.example"
         // You can update the following values to match your application needs.
         // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration.
-        minSdkVersion 21
+        minSdkVersion flutter.minSdkVersion
         targetSdkVersion flutter.targetSdkVersion
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName

example/android/build.gradle

@@ -1,5 +1,5 @@
 buildscript {
-    ext.kotlin_version = '1.7.10'
+    ext.kotlin_version = '1.7.22'
     repositories {
         google()
         mavenCentral()

example/android/settings.gradle

@@ -17,4 +17,4 @@ pluginManagement {
 
 include ":app"
 
-apply from: "${settings.ext.flutterSdkPath}/packages/flutter_tools/gradle/app_plugin_loader.gradle"
+