Skip to content

Commit b1cbb35

Browse files
authored
chore(all): Specify plugin requirements, clean up README files (#2907)
1 parent 2a547eb commit b1cbb35

File tree

11 files changed

+117
-47
lines changed

11 files changed

+117
-47
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<h1 align="center">Plus plugins</h1>
22
<p align="center">
33
<a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener">
4-
<img src="./website/static/img/flutter-favorite-badge.png" width="20%" alt="build">
4+
<img src="./assets/flutter-favorite-badge.png" width="15%" alt="build">
55
</a>
66
</p>
77

assets/flutter-favorite-badge.png

21.6 KB
Loading

packages/android_alarm_manager_plus/README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# android_alarm_manager_plus
22

3-
[![Flutter Community: android_alarm_manager_plus](https://fluttercommunity.dev/_github/header/android_alarm_manager_plus)](https://github.com/fluttercommunity/community)
4-
53
[![pub package](https://img.shields.io/pub/v/android_alarm_manager_plus.svg)](https://pub.dev/packages/android_alarm_manager_plus)
64
[![pub points](https://img.shields.io/pub/points/android_alarm_manager_plus?color=2E8B57&label=pub%20points)](https://pub.dev/packages/android_alarm_manager_plus/score)
75
[![android_alarm_manager_plus](https://github.com/fluttercommunity/plus_plugins/actions/workflows/android_alarm_manager_plus.yaml/badge.svg)](https://github.com/fluttercommunity/plus_plugins/actions/workflows/android_alarm_manager_plus.yaml)
86

9-
<div style="text-align: center;"><a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener"><img src="../../website/static/img/flutter-favorite-badge.png" width="100" alt="build"></a></div>
7+
[<img src="../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)
108

119
A Flutter plugin for accessing the Android AlarmManager service, and running
1210
Dart code in the background when alarms fire.
@@ -17,9 +15,18 @@ Dart code in the background when alarms fire.
1715
| :-----: |
1816
||
1917

18+
## Requirements
19+
20+
- Flutter >=3.3.0
21+
- Dart >=2.18.0 <4.0.0
22+
- Android `compileSDK` 34
23+
- Java 17
24+
- Android Gradle Plugin >=8.3.0
25+
- Gradle wrapper >=8.4
26+
2027
## Getting Started
2128

22-
> [!IMPORTANT]
29+
> [!IMPORTANT]
2330
> You would also need a plugin to request [SCHEDULE_EXACT_ALARM](https://developer.android.com/reference/android/Manifest.permission#SCHEDULE_EXACT_ALARM) permission if your app targets Android 14 and newer.
2431
> Google introduced SCHEDULE_EXACT_ALARM permission in [Android 12](https://developer.android.com/about/versions/12/behavior-changes-12#exact-alarm-permission). In Android 13 it was granted by default.
2532
> Since Android 14 this permission [is denied by default](https://developer.android.com/about/versions/14/changes/schedule-exact-alarms) and apps need to ask user to provide it.
@@ -95,7 +102,7 @@ using.
95102

96103
## Receiving show intents for alarm clocks
97104

98-
If your app is an alarm clock app and sets alarms using the `alarmClock` argument in [`oneShot`](https://pub.dev/documentation/android_alarm_manager_plus/latest/android_alarm_manager_plus/AndroidAlarmManager/oneShot.html) or [`oneShotAt`](https://pub.dev/documentation/android_alarm_manager_plus/latest/android_alarm_manager_plus/AndroidAlarmManager/oneShotAt.html), you can receive [intents](https://developer.android.com/reference/android/content/Intent) when user interacts with system UI that shows the next alarm. An example is the alarm tile in Android [quick-setting tiles](https://developer.android.com/develop/ui/views/quicksettings-tiles). This functionality is to allow you to show users the relevant alarm, or allow them to edit it when they tap on such UIs.
105+
If your app is an alarm clock app and sets alarms using the `alarmClock` argument in [`oneShot`](https://pub.dev/documentation/android_alarm_manager_plus/latest/android_alarm_manager_plus/AndroidAlarmManager/oneShot.html) or [`oneShotAt`](https://pub.dev/documentation/android_alarm_manager_plus/latest/android_alarm_manager_plus/AndroidAlarmManager/oneShotAt.html), you can receive [intents](https://developer.android.com/reference/android/content/Intent) when user interacts with system UI that shows the next alarm. An example is the alarm tile in Android [quick-setting tiles](https://developer.android.com/develop/ui/views/quicksettings-tiles). This functionality is to allow you to show users the relevant alarm, or allow them to edit it when they tap on such UIs.
99106

100107
This intent has the action `android.intent.action.MAIN` and includes the following `extras`:
101108
- `id`: The alarm id that you passed when scheduling the alarm.

packages/android_intent_plus/README.md

+18-9
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
11
# android_intent_plus
22

3-
[![Flutter Community: android_intent_plus](https://fluttercommunity.dev/_github/header/android_intent_plus)](https://github.com/fluttercommunity/community)
4-
53
[![pub package](https://img.shields.io/pub/v/android_intent_plus.svg)](https://pub.dev/packages/android_intent_plus)
64
[![pub points](https://img.shields.io/pub/points/android_intent_plus?color=2E8B57&label=pub%20points)](https://pub.dev/packages/android_intent_plus/score)
75
[![android_intent_plus](https://github.com/fluttercommunity/plus_plugins/actions/workflows/android_intent_plus.yaml/badge.svg)](https://github.com/fluttercommunity/plus_plugins/actions/workflows/android_intent_plus.yaml)
86

9-
<center><a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener"><img src="../../website/static/img/flutter-favorite-badge.png" width="100" alt="build"></a></center>
7+
[<img src="../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)
108

119
This plugin allows Flutter apps to launch arbitrary intents when the platform is Android.
1210

11+
## Platform Support
12+
13+
| Android |
14+
| :-----: |
15+
||
16+
17+
## Requirements
18+
19+
- Flutter >=3.3.0
20+
- Dart >=2.18.0 <4.0.0
21+
- Android `compileSDK` 34
22+
- Java 17
23+
- Android Gradle Plugin >=8.3.0
24+
- Gradle wrapper >=8.4
25+
26+
## Usage
27+
1328
> **Warning**
1429
>
1530
> If the plugin is invoked on iOS, it will crash your app. In checked mode, we assert that the platform should be Android.
@@ -68,12 +83,6 @@ of integers or strings.
6883
> ACTION_VIEW intents for Android, however this intent plugin also allows
6984
> clients to set extra parameters for the intent.
7085
71-
## Platform Support
72-
73-
| Android |
74-
| :-----: |
75-
||
76-
7786
## Android 11 package visibility
7887

7988
Android 11 introduced new permissions for package visibility.

packages/battery_plus/battery_plus/README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# battery_plus
22

3-
[![Flutter Community: battery_plus](https://fluttercommunity.dev/_github/header/battery_plus)](https://github.com/fluttercommunity/community)
4-
53
[![pub package](https://img.shields.io/pub/v/battery_plus.svg)](https://pub.dev/packages/battery_plus)
64
[![pub points](https://img.shields.io/pub/points/battery_plus?color=2E8B57&label=pub%20points)](https://pub.dev/packages/battery_plus/score)
75
[![battery_plus](https://github.com/fluttercommunity/plus_plugins/actions/workflows/battery_plus.yaml/badge.svg)](https://github.com/fluttercommunity/plus_plugins/actions/workflows/battery_plus.yaml)
86

9-
<p class="center">
10-
<center><a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener"><img src="../../../website/static/img/flutter-favorite-badge.png" width="100" alt="build"></a></center>
11-
</p>
7+
[<img src="../../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)
128

139
A Flutter plugin to access various information about the battery of the device the app is running on.
1410

@@ -18,6 +14,17 @@ A Flutter plugin to access various information about the battery of the device t
1814
| :-----: | :-: | :---: | :-: | :---: | :----: |
1915
|||||||
2016

17+
## Requirements
18+
19+
- Flutter >=3.3.0
20+
- Dart >=2.18.0 <4.0.0
21+
- iOS >=12.0
22+
- MacOS >=10.14
23+
- Android `compileSDK` 34
24+
- Java 17
25+
- Android Gradle Plugin >=8.3.0
26+
- Gradle wrapper >=8.4
27+
2128
## Usage
2229

2330
Add `battery_plus` as a dependency in your pubspec.yaml file.

packages/connectivity_plus/connectivity_plus/README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# connectivity_plus
22

3-
[![Flutter Community: connectivity_plus](https://fluttercommunity.dev/_github/header/connectivity_plus)](https://github.com/fluttercommunity/community)
4-
53
[![pub package](https://img.shields.io/pub/v/connectivity_plus.svg)](https://pub.dev/packages/connectivity_plus)
64
[![pub points](https://img.shields.io/pub/points/connectivity_plus?color=2E8B57&label=pub%20points)](https://pub.dev/packages/connectivity_plus/score)
75
[![connectivity_plus](https://github.com/fluttercommunity/plus_plugins/actions/workflows/connectivity_plus.yaml/badge.svg)](https://github.com/fluttercommunity/plus_plugins/actions/workflows/connectivity_plus.yaml)
86

9-
<p class="center">
10-
<center><a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener"><img src="../../../website/static/img/flutter-favorite-badge.png" width="100" alt="build"></a></center>
11-
</p>
7+
[<img src="../../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)
128

139
This plugin allows Flutter apps to discover network connectivity types that can be used.
1410

@@ -24,6 +20,17 @@ This plugin allows Flutter apps to discover network connectivity types that can
2420
| :-----: | :-: | :---: | :-: | :---: | :-----: |
2521
|||||||
2622

23+
## Requirements
24+
25+
- Flutter >=3.3.0
26+
- Dart >=2.18.0 <4.0.0
27+
- iOS >=12.0
28+
- MacOS >=10.14
29+
- Android `compileSDK` 34
30+
- Java 17
31+
- Android Gradle Plugin >=8.3.0
32+
- Gradle wrapper >=8.4
33+
2734
## Usage
2835

2936
Sample usage to check currently available connection types:

packages/device_info_plus/device_info_plus/README.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
# device_info_plus
22

3-
[![Flutter Community: device_info_plus](https://fluttercommunity.dev/_github/header/device_info_plus)](https://github.com/fluttercommunity/community)
4-
53
[![pub package](https://img.shields.io/pub/v/device_info_plus.svg)](https://pub.dev/packages/device_info_plus)
64
[![pub points](https://img.shields.io/pub/points/device_info_plus?color=2E8B57&label=pub%20points)](https://pub.dev/packages/device_info_plus/score)
75
[![device_info_plus](https://github.com/fluttercommunity/plus_plugins/actions/workflows/device_info_plus.yaml/badge.svg)](https://github.com/fluttercommunity/plus_plugins/actions/workflows/device_info_plus.yaml)
86

9-
<p class="center">
10-
<center><a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener"><img src="../../../website/static/img/flutter-favorite-badge.png" width="100" alt="build"></a></center>
11-
</p>
7+
[<img src="../../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)
8+
129
Get current device information from within the Flutter application.
1310

1411
## Platform Support
@@ -17,6 +14,17 @@ Get current device information from within the Flutter application.
1714
| :-----: | :-: | :---: | :-: | :---: | :-----: |
1815
|||||||
1916

17+
## Requirements
18+
19+
- Flutter >=3.3.0
20+
- Dart >=2.18.0 <4.0.0
21+
- iOS >=12.0
22+
- MacOS >=10.14
23+
- Android `compileSDK` 34
24+
- Java 17
25+
- Android Gradle Plugin >=8.3.0
26+
- Gradle wrapper >=8.4
27+
2028
# Usage
2129

2230
Import `package:device_info_plus/device_info_plus.dart`, instantiate `DeviceInfoPlugin`

packages/network_info_plus/network_info_plus/README.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# network_info_plus
22

3-
[![Flutter Community: network_info_plus](https://fluttercommunity.dev/_github/header/network_info_plus)](https://github.com/fluttercommunity/community)
4-
53
[![pub package](https://img.shields.io/pub/v/network_info_plus.svg)](https://pub.dev/packages/network_info_plus)
64
[![pub points](https://img.shields.io/pub/points/network_info_plus?color=2E8B57&label=pub%20points)](https://pub.dev/packages/network_info_plus/score)
75
[![network_info_plus](https://github.com/fluttercommunity/plus_plugins/actions/workflows/network_info_plus.yaml/badge.svg)](https://github.com/fluttercommunity/plus_plugins/actions/workflows/network_info_plus.yaml)
86

9-
<p class="center">
10-
<center><a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener"><img src="../../../website/static/img/flutter-favorite-badge.png" width="100" alt="build"></a></center>
11-
</p>
7+
[<img src="../../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)
128

139
This plugin allows Flutter apps to discover network info and configure
1410
themselves accordingly.
@@ -21,6 +17,17 @@ themselves accordingly.
2117

2218
The functionality is not supported on Web.
2319

20+
## Requirements
21+
22+
- Flutter >=3.3.0
23+
- Dart >=2.18.0 <4.0.0
24+
- iOS >=12.0
25+
- MacOS >=10.14
26+
- Android `compileSDK` 34
27+
- Java 17
28+
- Android Gradle Plugin >=8.3.0
29+
- Gradle wrapper >=8.4
30+
2431
## Usage
2532

2633
You can get Wi-Fi related information using:
@@ -131,7 +138,7 @@ The example application for this project, implements number 1 using the [permiss
131138

132139
Also, **your application needs the "com.apple.developer.networking.wifi-info" entitlement.**
133140

134-
This entitlement can be configured in xcode with the name "Access Wi-Fi information", and it is also found in the file `Runner.entitlements` in the example project. However,
141+
This entitlement can be configured in xcode with the name "Access Wi-Fi information", and it is also found in the file `Runner.entitlements` in the example project. However,
135142
**this entitlement is only possible when using a professional development team** and not a "Personal development team".
136143

137144
Without complying with these conditions, the calls to `.getWifiBSSID()` and `.getWifiName()` will return null.

packages/package_info_plus/package_info_plus/README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# package_info_plus
22

3-
[![Flutter Community: package_info_plus](https://fluttercommunity.dev/_github/header/package_info_plus)](https://github.com/fluttercommunity/community)
4-
53
[![package_info_plus](https://github.com/fluttercommunity/plus_plugins/actions/workflows/package_info_plus.yaml/badge.svg)](https://github.com/fluttercommunity/plus_plugins/actions/workflows/package_info_plus.yaml)
64
[![pub points](https://img.shields.io/pub/points/package_info_plus?color=2E8B57&label=pub%20points)](https://pub.dev/packages/package_info_plus/score)
75
[![pub package](https://img.shields.io/pub/v/package_info_plus.svg)](https://pub.dev/packages/package_info_plus)
86

9-
<p class="center">
10-
<center><a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener"><img src="../../../website/static/img/flutter-favorite-badge.png" width="100" alt="build"></a></center>
11-
</p>
7+
[<img src="../../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)
128

139
This Flutter plugin provides an API for querying information about an application package.
1410

@@ -18,6 +14,17 @@ This Flutter plugin provides an API for querying information about an applicatio
1814
| :-----: | :---: | :---: | :---: | :---: | :-----: |
1915
|||||||
2016

17+
## Requirements
18+
19+
- Flutter >=3.3.0
20+
- Dart >=2.18.0 <4.0.0
21+
- iOS >=12.0
22+
- MacOS >=10.14
23+
- Android `compileSDK` 34
24+
- Java 17
25+
- Android Gradle Plugin >=8.3.0
26+
- Gradle wrapper >=8.4
27+
2128
## Usage
2229

2330
You can use the PackageInfo to query information about the application package. This works both on

packages/sensors_plus/sensors_plus/README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# sensors_plus
22

3-
[![Flutter Community: sensors_plus](https://fluttercommunity.dev/_github/header/sensors_plus)](https://github.com/fluttercommunity/community)
4-
53
[![sensors_plus](https://github.com/fluttercommunity/plus_plugins/actions/workflows/sensors_plus.yaml/badge.svg)](https://github.com/fluttercommunity/plus_plugins/actions/workflows/sensors_plus.yaml)
64
[![pub points](https://img.shields.io/pub/points/sensors_plus?color=2E8B57&label=pub%20points)](https://pub.dev/packages/sensors_plus/score)
75
[![pub package](https://img.shields.io/pub/v/sensors_plus.svg)](https://pub.dev/packages/sensors_plus)
86

9-
<a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener"><img src="../../../website/static/img/flutter-favorite-badge.png" width="100" alt="build"></a>
7+
[<img src="../../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)
108

119
A Flutter plugin to access the accelerometer, gyroscope, and magnetometer
1210
sensors.
@@ -19,6 +17,17 @@ sensors.
1917

2018
\* Currently it is not possible to set sensors sampling rate on web
2119

20+
## Requirements
21+
22+
- Flutter >=3.3.0
23+
- Dart >=2.18.0 <4.0.0
24+
- iOS >=12.0
25+
- MacOS >=10.14
26+
- Android `compileSDK` 34
27+
- Java 17
28+
- Android Gradle Plugin >=8.3.0
29+
- Gradle wrapper >=8.4
30+
2231
## Usage
2332

2433
Add `sensors_plus` as a dependency in your pubspec.yaml file.

packages/share_plus/share_plus/README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# share_plus
22

3-
[![Flutter Community: share_plus](https://fluttercommunity.dev/_github/header/share_plus)](https://github.com/fluttercommunity/community)
4-
53
[![share_plus](https://github.com/fluttercommunity/plus_plugins/actions/workflows/share_plus.yaml/badge.svg)](https://github.com/fluttercommunity/plus_plugins/actions/workflows/share_plus.yaml)
64
[![pub points](https://img.shields.io/pub/points/share_plus?color=2E8B57&label=pub%20points)](https://pub.dev/packages/share_plus/score)
75
[![pub package](https://img.shields.io/pub/v/share_plus.svg)](https://pub.dev/packages/share_plus)
86

9-
<a href="https://flutter.dev/docs/development/packages-and-plugins/favorites" target="_blank" rel="noreferrer noopener"><img src="../../../website/static/img/flutter-favorite-badge.png" width="100" alt="build"></a>
7+
[<img src="../../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)
108

119
A Flutter plugin to share content from your Flutter app via the platform's
1210
share dialog.
@@ -26,6 +24,17 @@ Also compatible with Windows and Linux by using "mailto" to share text via Email
2624

2725
Sharing files is not supported on Linux.
2826

27+
## Requirements
28+
29+
- Flutter >=3.3.0
30+
- Dart >=2.18.0 <4.0.0
31+
- iOS >=12.0
32+
- MacOS >=10.14
33+
- Android `compileSDK` 34
34+
- Java 17
35+
- Android Gradle Plugin >=8.3.0
36+
- Gradle wrapper >=8.4
37+
2938
## Usage
3039

3140
To use this plugin, add `share_plus` as a [dependency in your pubspec.yaml file](https://plus.fluttercommunity.dev/docs/overview).

0 commit comments

Comments
 (0)