From 9b66f2044a583c524f89b2602de79188f4a5cd89 Mon Sep 17 00:00:00 2001 From: Hugo Pointcheval Date: Tue, 28 Dec 2021 16:02:55 +0100 Subject: [PATCH] Update license, and readme --- native_crypto_ios/CHANGELOG.md | 4 +--- native_crypto_ios/LICENSE | 2 +- native_crypto_ios/README.md | 4 ++-- native_crypto_ios/pubspec.yaml | 2 +- native_crypto_platform_interface/CHANGELOG.md | 4 +--- native_crypto_platform_interface/LICENSE | 24 ++++++++++++++++++- native_crypto_platform_interface/README.md | 20 ++++++---------- .../lib/src/platform_interface.dart | 20 ++++++++-------- native_crypto_platform_interface/pubspec.yaml | 2 +- ...native_crypto_platform_interface_test.dart | 1 + 10 files changed, 48 insertions(+), 35 deletions(-) diff --git a/native_crypto_ios/CHANGELOG.md b/native_crypto_ios/CHANGELOG.md index 41cc7d8..403c448 100644 --- a/native_crypto_ios/CHANGELOG.md +++ b/native_crypto_ios/CHANGELOG.md @@ -1,3 +1 @@ -## 0.0.1 - -* TODO: Describe initial release. +Check [`native_crypto`](../native_crypto/CHANGELOG.md) plugin's changelog. \ No newline at end of file diff --git a/native_crypto_ios/LICENSE b/native_crypto_ios/LICENSE index a9f90ec..8c5c1f7 100644 --- a/native_crypto_ios/LICENSE +++ b/native_crypto_ios/LICENSE @@ -2,7 +2,7 @@ NativeCrypto - iOS Implementation MIT License -Copyright (c) 2021 Hugo Pointcheval +Copyright (c) 2019 - 2022 Hugo Pointcheval Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/native_crypto_ios/README.md b/native_crypto_ios/README.md index 302c828..a60dd49 100644 --- a/native_crypto_ios/README.md +++ b/native_crypto_ios/README.md @@ -1,6 +1,6 @@ -# native_crypto_ios +# NativeCrypto - iOS Implementation -A new flutter plugin project. +iOS Implementation of NativeCrypto Plugin. ## Getting Started diff --git a/native_crypto_ios/pubspec.yaml b/native_crypto_ios/pubspec.yaml index 211e4de..c6441c5 100644 --- a/native_crypto_ios/pubspec.yaml +++ b/native_crypto_ios/pubspec.yaml @@ -1,6 +1,6 @@ name: native_crypto_ios description: iOS implementation of NativeCrypto -version: 0.0.7 +version: 0.1.0 environment: sdk: ">=2.15.0 <3.0.0" diff --git a/native_crypto_platform_interface/CHANGELOG.md b/native_crypto_platform_interface/CHANGELOG.md index 41cc7d8..403c448 100644 --- a/native_crypto_platform_interface/CHANGELOG.md +++ b/native_crypto_platform_interface/CHANGELOG.md @@ -1,3 +1 @@ -## 0.0.1 - -* TODO: Describe initial release. +Check [`native_crypto`](../native_crypto/CHANGELOG.md) plugin's changelog. \ No newline at end of file diff --git a/native_crypto_platform_interface/LICENSE b/native_crypto_platform_interface/LICENSE index ba75c69..68bb0c6 100644 --- a/native_crypto_platform_interface/LICENSE +++ b/native_crypto_platform_interface/LICENSE @@ -1 +1,23 @@ -TODO: Add your license here. +NativeCrypto - Platform Interface + +MIT License + +Copyright (c) 2019 - 2022 Hugo Pointcheval + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/native_crypto_platform_interface/README.md b/native_crypto_platform_interface/README.md index 7190aa2..d1cde17 100644 --- a/native_crypto_platform_interface/README.md +++ b/native_crypto_platform_interface/README.md @@ -1,18 +1,12 @@ -# native_crypto_platform_interface +# NativeCrypto - Platform Interface -A new flutter plugin project. +A common platform interface for the [`native_crypto`][1] plugin. -## Getting Started +This interface allows platform-specific implementations of the `native_crypto` plugin, as well as the plugin itself, to ensure they are supporting the same interface. -This project is a starting point for a Flutter -[plug-in package](https://flutter.dev/developing-packages/), -a specialized package that includes platform-specific implementation code for -Android and/or iOS. +## Usage -For help getting started with Flutter, view our -[online documentation](https://flutter.dev/docs), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +To implement a new platform-specific implementation of `native_crypto`, extend [`NativeCryptoPlatform`][2] with an implementation that performs the platform-specific behavior, and when you register your plugin, set the default `NativeCryptoPlatform` by calling `NativeCryptoPlatform.instance = MyNativeCryptoPlatform()`. -The plugin project was generated without specifying the `--platforms` flag, no platforms are currently supported. -To add platforms, run `flutter create -t plugin --platforms .` under the same -directory. You can also find a detailed instruction on how to add platforms in the `pubspec.yaml` at https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin-platforms. +[1]: ../native_crypto +[2]: lib/native_crypto_platform_interface.dart \ No newline at end of file diff --git a/native_crypto_platform_interface/lib/src/platform_interface.dart b/native_crypto_platform_interface/lib/src/platform_interface.dart index d0585c9..89267a0 100644 --- a/native_crypto_platform_interface/lib/src/platform_interface.dart +++ b/native_crypto_platform_interface/lib/src/platform_interface.dart @@ -3,7 +3,7 @@ // ----- // File: platform_interface.dart // Created Date: 25/12/2021 16:52:56 -// Last Modified: 25/12/2021 16:53:36 +// Last Modified: 27/12/2021 21:25:39 // ----- // Copyright (c) 2021 @@ -20,18 +20,18 @@ import 'package:meta/meta.dart'; /// Sample usage: /// /// ```dart -/// abstract class UrlLauncherPlatform extends PlatformInterface { -/// UrlLauncherPlatform() : super(token: _token); +/// abstract class NativeCryptoPlatform extends PlatformInterface { +/// NativeCryptoPlatform() : super(token: _token); /// -/// static UrlLauncherPlatform _instance = MethodChannelUrlLauncher(); +/// static NativeCryptoPlatform _instance = MethodChannelNativeCrypto(); /// /// static const Object _token = Object(); /// -/// static UrlLauncherPlatform get instance => _instance; +/// static NativeCryptoPlatform get instance => _instance; /// /// /// Platform-specific plugins should set this with their own platform-specific -/// /// class that extends [UrlLauncherPlatform] when they register themselves. -/// static set instance(UrlLauncherPlatform instance) { +/// /// class that extends [NativeCryptoPlatform] when they register themselves. +/// static set instance(NativeCryptoPlatform instance) { /// PlatformInterface.verifyToken(instance, _token); /// _instance = instance; /// } @@ -86,12 +86,12 @@ abstract class PlatformInterface { /// /// This class is intended for use in tests only. /// -/// Sample usage (assuming UrlLauncherPlatform extends [PlatformInterface]: +/// Sample usage (assuming NativeCryptoPlatform extends [PlatformInterface]: /// /// ```dart -/// class UrlLauncherPlatformMock extends Mock +/// class NativeCryptoPlatformMock extends Mock /// with MockPlatformInterfaceMixin -/// implements UrlLauncherPlatform {} +/// implements NativeCryptoPlatform {} /// ``` @visibleForTesting abstract class MockPlatformInterfaceMixin implements PlatformInterface {} \ No newline at end of file diff --git a/native_crypto_platform_interface/pubspec.yaml b/native_crypto_platform_interface/pubspec.yaml index 017ea35..3e90763 100644 --- a/native_crypto_platform_interface/pubspec.yaml +++ b/native_crypto_platform_interface/pubspec.yaml @@ -1,6 +1,6 @@ name: native_crypto_platform_interface description: A common interface for NativeCrypto plugin. -version: 0.0.7 +version: 0.1.0 environment: sdk: ">=2.15.0 <3.0.0" diff --git a/native_crypto_platform_interface/test/native_crypto_platform_interface_test.dart b/native_crypto_platform_interface/test/native_crypto_platform_interface_test.dart index e69de29..0ffdd02 100644 --- a/native_crypto_platform_interface/test/native_crypto_platform_interface_test.dart +++ b/native_crypto_platform_interface/test/native_crypto_platform_interface_test.dart @@ -0,0 +1 @@ +// TODO \ No newline at end of file