Update documentation for 1.0.0 release

rekire · Apr 21, 2024 · bd91eaf · bd91eaf
1 parent 91d1672
commit bd91eaf
Show file tree

Hide file tree

Showing 24 changed files with 327 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,38 +1,58 @@
-##  0.1.1
+## 1.0.0
+
+* First official stable version
+* Improved documentation to have a full documentation coverage
+
+## 0.2.0
+
+* Add Windows support
+
+## 0.1.1
+
 * Extend the documentation
 
 ## 0.1.0
+
 * Add Linux support
 * Duplicating (test) code
-* Use the same method channel structure for all platforms with maps instead of json
+* Use the same method channel structure for all platforms with maps instead of
+  json
 * Setting everything up for publishing on pub.dev
 
 ## 0.0.6
+
 * Fix build issues on Android
 * Migrate to plugins block
 
 ## 0.0.5
+
 * Migrated to federated plugin structure
 * Migrated on Android to the CredentialManager API
-* Added on Android zero touch login options by using the BlockManager to sync a login token across all (Google PlayService compatible) devices of a user
+* Added on Android zero touch login options by using the BlockManager to sync a
+  login token across all (Google PlayService compatible) devices of a user
 * Add MacOS support
 * Use the KeyValueStore to sync login tokens cross iOS and MacOS
 * Fixed loading credentials on iOS
-* Added tons of tests and CI improvements heavily inspired by very_good_flutter_plugin
+* Added tons of tests and CI improvements heavily inspired by
+  very_good_flutter_plugin
 * Add editor config for better common formatting
 
 ## 0.0.4
+
 * Updated dependencies (Flutter, Gradle, Dart, Kotlin)
 * Cleanup
-* Added placeholder test 
+* Added placeholder test
 
 ## 0.0.3
+
 * Allow nullable credentials
 
 ## 0.0.2
+
 * First release with null safety
 * Added web support
 * Sample page for the usage on github pages
 
 ## 0.0.1
+
 * Initial release
diff --git a/autologin/CHANGELOG.md b/autologin/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 1.0.0
+
+* First official stable version
+* Improved documentation to have a full documentation coverage
+
 ## 0.2.0
 
 * Add Windows support

diff --git a/autologin/lib/autologin.dart b/autologin/lib/autologin.dart
@@ -1,3 +1,11 @@
+/// The public interface of the AutologinPlugin. For a quick synchronous check
+/// you can check [isPlatformSupported]. When you need a full report of the
+/// [Compatibilities] you can [performCompatibilityChecks]. You can check the
+/// [Compatibilities] class for the details. With [requestCredentials] your
+/// saved [Credential]s can be requested which you need to safe before with
+/// [saveCredentials].
+library;
+
 import 'package:autologin_platform_interface/autologin_platform_interface.dart';
 export 'package:autologin_platform_interface/autologin_platform_interface.dart'
     show Compatibilities, Credential;

diff --git a/autologin/pubspec.yaml b/autologin/pubspec.yaml
@@ -1,6 +1,6 @@
 name: autologin
 description: This Plugin helps the developer to auto login into their app as simple as possible.
-version: 0.2.0
+version: 1.0.0
 homepage: https://github.com/rekire/autologin_plugin
 
 environment:
@@ -24,12 +24,12 @@ flutter:
         default_package: autologin_windows
 
 dependencies:
-  autologin_android: ^0.1.0
-  autologin_darwin: ^0.1.0
-  autologin_linux: ^0.1.0
-  autologin_platform_interface: ^0.1.0
-  autologin_web: ^0.1.0
-  autologin_windows: ^0.2.0
+  autologin_android: ^1.0.0
+  autologin_darwin: ^1.0.0
+  autologin_linux: ^1.0.0
+  autologin_platform_interface: ^1.0.0
+  autologin_web: ^1.0.0
+  autologin_windows: ^1.0.0
   flutter:
     sdk: flutter
 

diff --git a/autologin_android/CHANGELOG.md b/autologin_android/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 1.0.0
+
+* First official stable version
+* Improved documentation to have a full documentation coverage
+
 ## 0.1.1
 
 * Extend the documentation

diff --git a/autologin_android/lib/autologin_android.dart b/autologin_android/lib/autologin_android.dart
@@ -1,3 +1,6 @@
+/// The Android implementation of [AutologinPlatform].
+library;
+
 import 'package:autologin_platform_interface/autologin_platform_interface.dart';
 
 /// The Android implementation of [AutologinPlatform].

diff --git a/autologin_android/pubspec.yaml b/autologin_android/pubspec.yaml
@@ -1,6 +1,6 @@
 name: autologin_android
 description: The platform implementation of the autologin plugin for Android.
-version: 0.1.1
+version: 1.0.0
 homepage: https://github.com/rekire/autologin_plugin/tree/main/autologin_android
 
 environment:
@@ -17,7 +17,7 @@ flutter:
         dartPluginClass: AutologinAndroid
 
 dependencies:
-  autologin_platform_interface: ^0.1.0
+  autologin_platform_interface: ^1.0.0
   flutter:
     sdk: flutter
 
@@ -26,7 +26,7 @@ dev_dependencies:
     git:
       url: https://github.com/rekire/autologin_plugin.git
       path: autologin_test_utils
-      ref: 0.1.1
+      ref: 1.0.0
   flutter_test:
     sdk: flutter
   plugin_platform_interface: ^2.0.0

diff --git a/autologin_darwin/CHANGELOG.md b/autologin_darwin/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 1.0.0
+
+* First official stable version
+* Improved documentation to have a full documentation coverage
+
 ## 0.1.1
 
 * Extend the documentation

diff --git a/autologin_darwin/lib/autologin_darwin.dart b/autologin_darwin/lib/autologin_darwin.dart
@@ -1,3 +1,6 @@
+/// The Darwin implementation of [AutologinPlatform] for iOS and MacOS.
+library;
+
 import 'package:autologin_platform_interface/autologin_platform_interface.dart';
 
 /// The Darwin implementation of [AutologinPlatform] for iOS and MacOS.

diff --git a/autologin_linux/CHANGELOG.md b/autologin_linux/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 1.0.0
+
+* First official stable version
+* Improved documentation to have a full documentation coverage
+
 ## 0.1.1
 
 * Extend the documentation

diff --git a/autologin_linux/lib/autologin_linux.dart b/autologin_linux/lib/autologin_linux.dart
@@ -1,3 +1,6 @@
+/// The Linux implementation of [AutologinPlatform].
+library;
+
 import 'package:autologin_platform_interface/autologin_platform_interface.dart';
 import 'package:flutter/services.dart';
 

diff --git a/autologin_linux/pubspec.yaml b/autologin_linux/pubspec.yaml
@@ -1,6 +1,6 @@
 name: autologin_linux
 description: The platform implementation of the autologin plugin for Linux.
-version: 0.1.1
+version: 1.0.0
 homepage: https://github.com/rekire/autologin_plugin/tree/main/autologin_linux
 
 environment:
@@ -16,7 +16,7 @@ flutter:
         dartPluginClass: AutologinLinux
 
 dependencies:
-  autologin_platform_interface: ^0.1.0
+  autologin_platform_interface: ^1.0.0
   flutter:
     sdk: flutter
 
@@ -25,7 +25,7 @@ dev_dependencies:
     git:
       url: https://github.com/rekire/autologin_plugin.git
       path: autologin_test_utils
-      ref: 0.1.1
+      ref: 1.0.0
   flutter_test:
     sdk: flutter
   very_good_analysis: ^5.1.0
diff --git a/autologin_platform_interface/CHANGELOG.md b/autologin_platform_interface/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 1.0.0
+
+* First official stable version
+* Improved documentation to have a full documentation coverage
+
 ## 0.1.1
 
 * Extend the documentation

diff --git a/autologin_platform_interface/lib/autologin_platform_interface.dart b/autologin_platform_interface/lib/autologin_platform_interface.dart
@@ -1,3 +1,12 @@
+/// The interface that implementations of autologin must implement.
+///
+/// Platform implementations should extend this class rather than implement it
+/// as `Autologin`. Extending this class (using `extends`) ensures that the
+/// subclass will get the default implementation, while platform implementations
+/// that `implements` this interface will be broken by newly added
+/// [AutologinPlatform] methods.
+library;
+
 import 'package:autologin_platform_interface/src/compatibilities.dart';
 import 'package:autologin_platform_interface/src/credential.dart';
 import 'package:autologin_platform_interface/src/method_channel_autologin.dart';

diff --git a/autologin_platform_interface/lib/src/compatibilities.freezed.dart b/autologin_platform_interface/lib/src/compatibilities.freezed.dart
diff --git a/autologin_platform_interface/lib/src/credential.freezed.dart b/autologin_platform_interface/lib/src/credential.freezed.dart
diff --git a/autologin_platform_interface/pubspec.yaml b/autologin_platform_interface/pubspec.yaml
@@ -1,6 +1,6 @@
 name: autologin_platform_interface
 description: The common platform interface with shared code for the autologin plugin.
-version: 0.1.1
+version: 1.0.0
 homepage: https://github.com/rekire/autologin_plugin/tree/main/autologin_platform_interface
 
 environment:

diff --git a/autologin_test_utils/pubspec.yaml b/autologin_test_utils/pubspec.yaml
@@ -1,14 +1,14 @@
 name: autologin_test_utils
 description: Shared code for tests to avoid to duplicating test code.
-version: 0.1.1
+version: 1.0.0
 homepage: https://github.com/rekire/autologin_plugin/tree/main/autologin_test_utils
 publish_to: none
 
 environment:
   sdk: '>=3.0.0 <4.0.0'
 
 dependencies:
-  autologin_platform_interface: ^0.1.0
+  autologin_platform_interface: ^1.0.0
   flutter:
     sdk: flutter
   flutter_test:

diff --git a/autologin_web/CHANGELOG.md b/autologin_web/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 1.0.0
+
+* First official stable version
+* Improved documentation to have a full documentation coverage
+
 ## 0.1.0
 
 * Add Linux support

diff --git a/autologin_web/lib/autologin_web.dart b/autologin_web/lib/autologin_web.dart
@@ -1,3 +1,6 @@
+/// The Web implementation of [AutologinPlatform].
+library;
+
 import 'dart:html';
 import 'dart:js';
 

diff --git a/autologin_windows/CHANGELOG.md b/autologin_windows/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 1.0.0
+
+* First official stable version
+* Improved documentation to have a full documentation coverage
+
 ## 0.2.0
 
 * Add Windows support
diff --git a/autologin_windows/example/lib/README.md b/autologin_windows/example/lib/README.md
@@ -0,0 +1,2 @@
+This example is just for pub.dev. If you want to run this sample use the
+[autologin example](../../../autologin/example).