Update license, and readme

This commit is contained in:
Hugo Pointcheval 2021-12-28 16:02:55 +01:00
parent 9e0d921564
commit 9b66f2044a
10 changed files with 48 additions and 35 deletions

View File

@ -1,3 +1 @@
## 0.0.1 Check [`native_crypto`](../native_crypto/CHANGELOG.md) plugin's changelog.
* TODO: Describe initial release.

View File

@ -2,7 +2,7 @@ NativeCrypto - iOS Implementation
MIT License 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 Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@ -1,6 +1,6 @@
# native_crypto_ios # NativeCrypto - iOS Implementation
A new flutter plugin project. iOS Implementation of NativeCrypto Plugin.
## Getting Started ## Getting Started

View File

@ -1,6 +1,6 @@
name: native_crypto_ios name: native_crypto_ios
description: iOS implementation of NativeCrypto description: iOS implementation of NativeCrypto
version: 0.0.7 version: 0.1.0
environment: environment:
sdk: ">=2.15.0 <3.0.0" sdk: ">=2.15.0 <3.0.0"

View File

@ -1,3 +1 @@
## 0.0.1 Check [`native_crypto`](../native_crypto/CHANGELOG.md) plugin's changelog.
* TODO: Describe initial release.

View File

@ -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.

View File

@ -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 ## Usage
[plug-in package](https://flutter.dev/developing-packages/),
a specialized package that includes platform-specific implementation code for
Android and/or iOS.
For help getting started with Flutter, view our 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()`.
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
The plugin project was generated without specifying the `--platforms` flag, no platforms are currently supported. [1]: ../native_crypto
To add platforms, run `flutter create -t plugin --platforms <platforms> .` under the same [2]: lib/native_crypto_platform_interface.dart
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.

View File

@ -3,7 +3,7 @@
// ----- // -----
// File: platform_interface.dart // File: platform_interface.dart
// Created Date: 25/12/2021 16:52:56 // 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 // Copyright (c) 2021
@ -20,18 +20,18 @@ import 'package:meta/meta.dart';
/// Sample usage: /// Sample usage:
/// ///
/// ```dart /// ```dart
/// abstract class UrlLauncherPlatform extends PlatformInterface { /// abstract class NativeCryptoPlatform extends PlatformInterface {
/// UrlLauncherPlatform() : super(token: _token); /// NativeCryptoPlatform() : super(token: _token);
/// ///
/// static UrlLauncherPlatform _instance = MethodChannelUrlLauncher(); /// static NativeCryptoPlatform _instance = MethodChannelNativeCrypto();
/// ///
/// static const Object _token = Object(); /// 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 /// /// Platform-specific plugins should set this with their own platform-specific
/// /// class that extends [UrlLauncherPlatform] when they register themselves. /// /// class that extends [NativeCryptoPlatform] when they register themselves.
/// static set instance(UrlLauncherPlatform instance) { /// static set instance(NativeCryptoPlatform instance) {
/// PlatformInterface.verifyToken(instance, _token); /// PlatformInterface.verifyToken(instance, _token);
/// _instance = instance; /// _instance = instance;
/// } /// }
@ -86,12 +86,12 @@ abstract class PlatformInterface {
/// ///
/// This class is intended for use in tests only. /// This class is intended for use in tests only.
/// ///
/// Sample usage (assuming UrlLauncherPlatform extends [PlatformInterface]: /// Sample usage (assuming NativeCryptoPlatform extends [PlatformInterface]:
/// ///
/// ```dart /// ```dart
/// class UrlLauncherPlatformMock extends Mock /// class NativeCryptoPlatformMock extends Mock
/// with MockPlatformInterfaceMixin /// with MockPlatformInterfaceMixin
/// implements UrlLauncherPlatform {} /// implements NativeCryptoPlatform {}
/// ``` /// ```
@visibleForTesting @visibleForTesting
abstract class MockPlatformInterfaceMixin implements PlatformInterface {} abstract class MockPlatformInterfaceMixin implements PlatformInterface {}

View File

@ -1,6 +1,6 @@
name: native_crypto_platform_interface name: native_crypto_platform_interface
description: A common interface for NativeCrypto plugin. description: A common interface for NativeCrypto plugin.
version: 0.0.7 version: 0.1.0
environment: environment:
sdk: ">=2.15.0 <3.0.0" sdk: ">=2.15.0 <3.0.0"