diff --git a/README.md b/README.md index 34ebaa2..d015c56 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,31 @@ # Flutter VPN plugin -This plugin help user to create VPN service in their app. +This plugin help developers to provide VPN service in their flutter app. +本插件帮助开发者在自己的应用内提供 VPN 服务。 + +The Android part was implemented by [strongswan](https://www.strongswan.org/) which support ikev2 protocol. +The iOS part not implemented yet. + +### Warning +This plugin is still under initial development. DO NOT use in production. + +## Installation + +### For Android + +Add the service in the `application` part your `AndroidManifest.xml`. +```xml + + + +``` + +Add native libs inside your `android/app/src/main/libs` . +The native libs can be build from strongswan. +You can also download the prebuild native libs [here](https://github.com/X-dea/Flutter_VPN/releases). diff --git a/example/test/widget_test.dart b/example/test/widget_test.dart index 8077c5a..c5de0d0 100644 --- a/example/test/widget_test.dart +++ b/example/test/widget_test.dart @@ -7,7 +7,6 @@ import 'package:flutter/material.dart'; import 'package:flutter_test/flutter_test.dart'; - import 'package:flutter_vpn_example/main.dart'; void main() { @@ -18,8 +17,8 @@ void main() { // Verify that platform version is retrieved. expect( find.byWidgetPredicate( - (Widget widget) => widget is Text && - widget.data.startsWith('Running on:'), + (Widget widget) => + widget is Text && widget.data.startsWith('Running on:'), ), findsOneWidget, ); diff --git a/pubspec.yaml b/pubspec.yaml index c0d2c37..1ba8458 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,8 +1,8 @@ name: flutter_vpn description: Flutter plugin for VPN service version: 0.0.1 -author: Jason C.H -homepage: +author: Jason C.H +homepage: https://github.com/X-dea/Flutter_VPN environment: sdk: ">=2.0.0-dev.68.0 <3.0.0"