docs: update plugin READMEs with new content and corrections

- Revised titles and installation commands for several plugins, including Adjust, AdMob Plus, and Approov Advanced HTTP.
- Added new README files for plugins such as Airship, Audio Management, and Genius Scan.
- Corrected plugin repository links and usage documentation across multiple plugins.
- Updated supported platforms and descriptions for clarity and accuracy.
- Enhanced consistency in formatting and structure throughout the documentation.
This commit is contained in:
Daniel Sogl
2025-06-07 16:42:22 +02:00
parent 82fec43427
commit 95f86044aa
36 changed files with 381 additions and 73 deletions
+4 -2
View File
@@ -1,5 +1,7 @@
# AdjustThirdPartySharing
ova plugin add com.adjust.sdk
# Adjust
```
$ ionic cordova plugin add com.adjust.sdk
$ npm install @awesome-cordova-plugins/adjust
```
+2 -6
View File
@@ -1,4 +1,4 @@
# RewardVideo
# AdMob Plus
```
$ ionic cordova plugin add cordova-admob-plus
@@ -7,11 +7,7 @@ $ npm install @awesome-cordova-plugins/admob-plus
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/admob-plus/)
Plugin Repo: []()
github.com/admob-plus/admob-plus](https://github.com/admob-plus/admob-plus)
Plugin Repo: [https://github.com/admob-plus/admob-plus](https://github.com/admob-plus/admob-plus)
AdMob Plus is the successor of cordova-plugin-admob-free, which provides a cleaner API and build with modern tools.
+20
View File
@@ -0,0 +1,20 @@
# Airship
```
$ ionic cordova plugin add @ua/cordova-airship
$ npm install @awesome-cordova-plugins/airship
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/airship/)
Plugin Repo: [https://www.npmjs.com/package/@ua/cordova-airship](https://www.npmjs.com/package/@ua/cordova-airship)
This plugin does something
## Supported platforms
- Android
- iOS
+2 -2
View File
@@ -1,13 +1,13 @@
# HTTP
```
$ ionic cordova plugin add cordova-approov-advanced-http
$ ionic cordova plugin add @approov/cordova-plugin-advanced-http
$ npm install @awesome-cordova-plugins/approov-advanced-http
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/approov-advanced-http/)
Plugin Repo: [https://github.com/approov/quickstart-ionic-advancedhttp](https://github.com/approov/quickstart-ionic-advancedhttp)
Plugin Repo: [https://github.com/approov/quickstart-cordova-advancedhttp](https://github.com/approov/quickstart-cordova-advancedhttp)
Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android.
+20
View File
@@ -0,0 +1,20 @@
# Audio Management
```
$ ionic cordova plugin add clovelced-plugin-audiomanagement
$ npm install @awesome-cordova-plugins/audio-management
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/audio-management/)
Plugin Repo: [https://github.com/clovelCed/cordova-plugin-audiomanagement](https://github.com/clovelCed/cordova-plugin-audiomanagement)
A Cordova plugin to manage volume of audio streams for: ring, music, notification and system. Possible
ringer values for those streams are: silent, vibrate and normal.
## Supported platforms
- Android
+18
View File
@@ -0,0 +1,18 @@
# DatamatrixBarcodeConfig
rdova plugin add barkoder-cordova
$ npm install @awesome-cordova-plugins/barkoder
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/barkoder/)
Plugin Repo: []()
The barKoder Barcode Scanner SDK cordova plugin grants an easy to use solution with a great and completely customizable interface that can be instantly integrated in both iOS and Android apps.
## Supported platforms
- Android
- iOS
+2 -2
View File
@@ -1,5 +1,5 @@
# CFPaymentComponentBuilder
nic cordova plugin add cordova-plugin-cashfree-pg
# CFUPIIntentCheckoutPayment
ic cordova plugin add cordova-plugin-cashfree-pg
$ npm install @awesome-cordova-plugins/cashfree-pg
```
+1 -1
View File
@@ -1,7 +1,7 @@
# Cloud Settings
```
$ ionic cordova plugin add cordova-plugin-cloud-settings --variable ANDROID_BACKUP_SERVICE_KEY=myapikey
$ ionic cordova plugin add @marysuon/cordova-plugin-cloud-settings --variable ANDROID_BACKUP_SERVICE_KEY=myapikey
$ npm install @awesome-cordova-plugins/cloud-settings
```
+27
View File
@@ -0,0 +1,27 @@
# Contacts
```
$ ionic cordova plugin add cordova-plugin-contacts
$ npm install @awesome-cordova-plugins/contacts
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/contacts/)
Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-contacts](https://github.com/herdwatch-apps/cordova-plugin-contacts)
Access and manage Contacts on the device.
## Supported platforms
- Android
- BlackBerry 10
- Browser
- Firefox OS
- iOS
- Ubuntu
- Windows
- Windows 8
- Windows Phone
+19
View File
@@ -0,0 +1,19 @@
# Document Downloader
```
$ ionic cordova plugin add integrator-cordova-plugin-downloader
$ npm install @awesome-cordova-plugins/downloader
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/downloader/)
Plugin Repo: [https://github.com/Luka313/integrator-cordova-plugin-downloader.git](https://github.com/Luka313/integrator-cordova-plugin-downloader.git)
This plugin is designed to support downloading files using Android DownloadManager.
## Supported platforms
- Android
+6 -2
View File
@@ -1,4 +1,4 @@
# Crashlytics
# Answers
```
$ ionic cordova plugin add cordova-fabric-plugin --variable FABRIC_API_KEY=XXX --variable FABRIC_API_SECRET=xxx
@@ -9,7 +9,7 @@ $ npm install @awesome-cordova-plugins/fabric
Plugin Repo: [https://www.npmjs.com/package/cordova-fabric-plugin](https://www.npmjs.com/package/cordova-fabric-plugin)
API for interacting with the Crashlytics kit.
API for interacting with the Answers kit.
https://docs.fabric.io/crashlytics/index.html
@@ -20,3 +20,7 @@ https://docs.fabric.io/crashlytics/index.html
OS
+2 -3
View File
@@ -1,7 +1,6 @@
# FirebaseModelInput
Result
t
cordova plugin add cordova-plugin-firebase-model
$ ionic cordova plugin add cordova-plugin-firebase-model
$ npm install @awesome-cordova-plugins/firebase-model
```
+20
View File
@@ -0,0 +1,20 @@
# Genius Scan
```
$ ionic cordova plugin add @thegrizzlylabs/cordova-plugin-genius-scan
$ npm install @awesome-cordova-plugins/genius-scan
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/genius-scan/)
Plugin Repo: []()
Plugin allows you to access the Genius Scan SDK core features from a Ionic application
## Supported platforms
- Android
- iOS
+4 -2
View File
@@ -1,6 +1,8 @@
# Coordinates
alidationError
ic cordova plugin add cordova-plugin-hypertrack-v3
ugin
```
$ ionic cordova plugin add cordova-plugin-hypertrack-v3
$ npm install @awesome-cordova-plugins/hyper-track
```
+7 -23
View File
@@ -1,36 +1,20 @@
# IRoot
```text
$ ionic cordova plugin add cordova-plugin-iroot
```
$ ionic cordova plugin add cordova-plugin-IRoot
$ npm install @awesome-cordova-plugins/i-root
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/iroot/)
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/i-root/)
Plugin Repo: [https://github.com/WuglyakBolgoink/cordova-plugin-iroot](https://github.com/WuglyakBolgoink/cordova-plugin-iroot)
Plugin Repo: [https://github.com/WuglyakBolgoink/cordova-plugin-IRoot](https://github.com/WuglyakBolgoink/cordova-plugin-IRoot)
Use this plugin to add an extra layer of security for your app by detecting if the device was rooted (on android) or jailbreaked (on iOS).
## Supported platforms
* Android
* iOS
- Android
- iOS
## Original Plugin Notes
### iOS - Postinstall
To avoid errors like
> -canOpenURL: failed for URL: "cydia://package/com.example.package" - error: "This app is not allowed to query for scheme cydia"
dont forget to add `"cydia"` in `LSApplicationQueriesSchemes` key of `info.plist`. Otherwise `canOpenURL` will always return `false`.
```xml
<xxx>
<key>LSApplicationQueriesSchemes</key>
<array>
<string>cydia</string>
</array>
</xxx>
```
+1
View File
@@ -33,6 +33,7 @@ Supports:
- **macOS** version 10
- **Xbox One**
- (and any platform supporting Microsoft's UWP)
- **cordova-plugin-purchase** version 12 or lower.
## Supported platforms
+47
View File
@@ -0,0 +1,47 @@
# "In App Purchase 3"
```
$ ionic cordova plugin add cordova-plugin-purchase --variable BILLING_KEY="<ANDROID_BILLING_KEY>"
$ npm install @awesome-cordova-plugins/in-app-purchase-3
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/in-app-purchase-3/)
Plugin Repo: [https://github.com/j3k0/cordova-plugin-purchase](https://github.com/j3k0/cordova-plugin-purchase)
In-App Purchase on iOS, Android, Windows, macOS and XBox.
This plugin replace the previous InAppPurchase2, due to backward compatibility issue with the wrapped
cordova-plugin-purchase version 13.0
## Features
| | ios | android | win-8 | win-10/uwp | mac |
|--|--|--|--|--|--|
| consumables | ✅ | ✅ | ✅ | ✅ | ✅ |
| non consumables | ✅ | ✅ | ✅ | ✅ | ✅ |
| subscriptions | ✅ | ✅ | ✅ | ✅ | ✅ |
| restore purchases | ✅ | ✅ | ✅ | ✅ | ✅ |
| receipt validations | ✅ | ✅ | | ✅ | ✅ |
| introductory prices | ✅ | ✅ | | ✅ | ✅ |
Supports:
- **iOS** version 7.0 or higher.
- **Android** version 2.2 (API level 8) or higher
- with Google Play client version 3.9.16 or higher
- **Windows** Store/Phone 8.1 or higher
- **Windows 10 Mobile**
- **macOS** version 10
- **Xbox One**
- (and any platform supporting Microsoft's UWP)
- **cordova-plugin-purchase** version 13.0 or higher
## Supported platforms
- iOS
- Android
- Windows
+1 -1
View File
@@ -10,7 +10,7 @@ $ npm install @awesome-cordova-plugins/intercom
Plugin Repo: [https://github.com/intercom/intercom-cordova](https://github.com/intercom/intercom-cordova)
This is a plugin that allows your Ionic app to use Intercom for iOS and/or Intercom for Android.
Follow the offical documentation to setup this plugin correctly: https://developers.intercom.com/docs/cordova-phonegap-configuration
Follow the offical documentation to setup this plugin correctly: https://developers.intercom.com/installing-intercom/cordova-phonegap/installation
## Supported platforms
+1 -2
View File
@@ -1,6 +1,5 @@
# Mobile Messaging
# CustomMessageStorage
```
$ ionic cordova plugin add com-infobip-plugins-mobilemessaging
$ npm install @awesome-cordova-plugins/mobile-messaging
```
+19
View File
@@ -0,0 +1,19 @@
# Network Permission
```
$ ionic cordova plugin add cordova-plugin-network-permission
$ npm install @awesome-cordova-plugins/network-permission
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/network-permission/)
Plugin Repo: [https://github.com/j5int/cordova-plugin-network-permission](https://github.com/j5int/cordova-plugin-network-permission)
Requires Cordova plugin: cordova-plugin-network-permission. For more info, please see the [Network permission plugin docs](https://github.com/j5int/cordova-plugin-network-permission).
## Supported platforms
- iOS
+2 -3
View File
@@ -1,7 +1,6 @@
# NFC
# UriHelper
```
$ ionic cordova plugin add phonegap-nfc
ionic cordova plugin add phonegap-nfc
$ npm install @awesome-cordova-plugins/nfc
```
+20
View File
@@ -0,0 +1,20 @@
# OpenInstall
```
$ ionic cordova plugin add cordova-plugin-openinstall
$ npm install @awesome-cordova-plugins/openinstall
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/openinstall/)
Plugin Repo: [https://github.com/openinstall/cordova-plugin-openinstall](https://github.com/openinstall/cordova-plugin-openinstall)
## Supported platforms
- Android
- iOS
+1 -1
View File
@@ -9,7 +9,7 @@ $ npm install @awesome-cordova-plugins/purchases
Plugin Repo: [https://github.com/RevenueCat/cordova-plugin-purchases](https://github.com/RevenueCat/cordova-plugin-purchases)
*Purchases* is a client for the [RevenueCat](https://www.revenuecat.com/) subscription and purchase tracking system.
Purchases* is a client for the [RevenueCat](https://www.revenuecat.com/) subscription and purchase tracking system.
It is an open source framework that provides a wrapper around `BillingClient`, `StoreKit` and the RevenueCat backend
to make implementing in-app subscriptions easy - receipt validation and status tracking included!
+6 -6
View File
@@ -1,6 +1,6 @@
# Save Dialog
# SaveDialog
```text
```
$ ionic cordova plugin add cordova-plugin-save-dialog
$ npm install @awesome-cordova-plugins/save-dialog
```
@@ -9,12 +9,12 @@ $ npm install @awesome-cordova-plugins/save-dialog
Plugin Repo: [https://github.com/Amphiluke/cordova-plugin-save-dialog](https://github.com/Amphiluke/cordova-plugin-save-dialog)
This Cordova plugin displays the native Save dialog which allows users to store a file in the selected location.
Plugin displays the native Save dialog which allows users to store a file in the selected location.
## Supported platforms
* Android
* iOS
- Android
- iOS
+20
View File
@@ -0,0 +1,20 @@
# Screenshot
```
$ ionic cordova plugin add @herdwatch/cordova-plugin-screenshot
$ npm install @awesome-cordova-plugins/screenshot
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/screenshot/)
Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-screenshot](https://github.com/herdwatch-apps/cordova-plugin-screenshot)
Captures a screen shot
## Supported platforms
- Android
- iOS
+23
View File
@@ -0,0 +1,23 @@
# ShortcutsAndroid
```
$ ionic cordova plugin add cordova-plugin-shortcuts-android
$ npm install @awesome-cordova-plugins/shortcuts-android
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/shortcuts-android/)
Plugin Repo: [https://github.com/avargaskun/cordova-plugin-shortcuts-android](https://github.com/avargaskun/cordova-plugin-shortcuts-android)
Use this plugin to create shortcuts in Android. Use this plugin to handle Intents on your application.
For more information on Android App Shortcuts: https://developer.android.com/guide/topics/ui/shortcuts.html
For more information on Android Intents: https://developer.android.com/guide/components/intents-filters.html
The work that went into creating this plug-in was inspired by the existing plugins: cordova-plugin-shortcut and cordova-plugin-webintent2.
## Supported platforms
- Android
+4 -2
View File
@@ -1,5 +1,7 @@
# ASAuthorizationAppleIDRequest
c cordova plugin add cordova-plugin-sign-in-with-apple
# Sign In With Apple
```
$ ionic cordova plugin add cordova-plugin-sign-in-with-apple
$ npm install @awesome-cordova-plugins/sign-in-with-apple
```
+4 -1
View File
@@ -14,4 +14,7 @@ Plugin Repo: [https://github.com/CWBudde/cordova-plugin-smtp-client](https://git
## Supported platforms
- Android
- iOS
- iOS
+20
View File
@@ -0,0 +1,20 @@
# SocketsTcp
```
$ ionic cordova plugin add https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp
$ npm install @awesome-cordova-plugins/sockets-tcp
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/sockets-tcp/)
Plugin Repo: [https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp](https://github.com/KoenLav/cordova-plugin-chrome-apps-sockets-tcp)
This plugin provides TCP client sockets for Android and iOS.
## Supported platforms
- Android
- iOS
+20
View File
@@ -0,0 +1,20 @@
# SocketsUdp
```
$ ionic cordova plugin add cordova-plugin-chrome-apps-sockets-udp
$ npm install @awesome-cordova-plugins/sockets-udp
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/sockets-udp/)
Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-chrome-apps-sockets-udp](https://github.com/herdwatch-apps/cordova-plugin-chrome-apps-sockets-udp)
This plugin provides UDP sockets for Android and iOS.
## Supported platforms
- Android
- iOS
@@ -1,7 +1,7 @@
# SSLCertificateChecker
```
$ ionic cordova plugin add cordova-plugin-sslcertificatechecker
$ ionic cordova plugin add SSLCertificateChecker-PhoneGap-Plugin
$ npm install @awesome-cordova-plugins/ssl-certificate-checker
```
@@ -11,7 +11,10 @@ Plugin Repo: [https://github.com/EddyVerbruggen/SSLCertificateChecker-PhoneGap-P
Cordova plugin to check SSL certificates on Android and iOS.
## Supported Platforms
## Supported platforms
- Android
- iOS
* Android
* iOS
+4 -2
View File
@@ -1,5 +1,7 @@
# ConsentExpiry
''
# Tealium
```
$ ''
$ npm install @awesome-cordova-plugins/tealium
```
+2 -2
View File
@@ -1,13 +1,13 @@
# 3D Touch
```
$ ionic cordova plugin add cordova-plugin-3dtouch
$ ionic cordova plugin add @herdwatch/cordova-plugin-3dtouch
$ npm install @awesome-cordova-plugins/three-dee-touch
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/three-dee-touch/)
Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-3dtouch](https://github.com/EddyVerbruggen/cordova-plugin-3dtouch)
Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-3dtouch](https://github.com/herdwatch-apps/cordova-plugin-3dtouch)
The 3D Touch plugin adds 3D Touch capabilities to your Cordova app.
+4 -4
View File
@@ -1,7 +1,7 @@
# SyncResult
ult
ivateResult
ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk
# Unvired Cordova SDK
```
$ ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk
$ npm install @awesome-cordova-plugins/unvired-cordova-sdk
```
+20
View File
@@ -0,0 +1,20 @@
# WE Cap Inbox
```
$ ionic cordova plugin add we-notificationinbox-cordova
$ npm install @awesome-cordova-plugins/we-cap-inbox
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/we-cap-inbox/)
Plugin Repo: [https://github.com/WebEngage/we-ionic-notification-inbox](https://github.com/WebEngage/we-ionic-notification-inbox)
This plugin provides functionalities to manage notifications in your app.
## Supported platforms
- Android
- iOS
+1 -2
View File
@@ -1,5 +1,4 @@
# UserPreferencesMethods
nderPush
# Push Notifications - WonderPush
```
$ ionic cordova plugin add wonderpush-cordova-sdk --variable CLIENT_ID=YOUR_CLIENT_ID --variable CLIENT_SECRET=YOUR_CLIENT_SECRET