From 3af036f93e48977c2c91f7b6a6b3965b44f3fbd3 Mon Sep 17 00:00:00 2001 From: Daniel Sogl Date: Thu, 27 Jan 2022 08:33:57 +0000 Subject: [PATCH] docs(): update generated readmes --- docs/plugins/adjust/README.md | 6 ++-- docs/plugins/chooser-simple-file/README.md | 32 ++++++++++++++++++++++ docs/plugins/magnetometer/README.md | 20 ++++++++++++++ docs/plugins/market/README.md | 20 ++++++++++++++ docs/plugins/purchases/README.md | 2 +- docs/plugins/smartlook/README.md | 6 ++-- docs/plugins/tealium/README.md | 4 +-- docs/plugins/unvired-cordova-sdk/README.md | 4 +-- 8 files changed, 83 insertions(+), 11 deletions(-) create mode 100644 docs/plugins/chooser-simple-file/README.md create mode 100644 docs/plugins/magnetometer/README.md create mode 100644 docs/plugins/market/README.md diff --git a/docs/plugins/adjust/README.md b/docs/plugins/adjust/README.md index 2cae84af1..d98d6baf8 100644 --- a/docs/plugins/adjust/README.md +++ b/docs/plugins/adjust/README.md @@ -1,5 +1,7 @@ -# AdjustPlayStoreSubscription -plugin add com.adjust.sdk +# Adjust + +``` +$ ionic cordova plugin add com.adjust.sdk $ npm install @awesome-cordova-plugins/adjust ``` diff --git a/docs/plugins/chooser-simple-file/README.md b/docs/plugins/chooser-simple-file/README.md new file mode 100644 index 000000000..09556ab20 --- /dev/null +++ b/docs/plugins/chooser-simple-file/README.md @@ -0,0 +1,32 @@ +# Chooser + +``` +$ ionic cordova plugin add cordova-plugin-simple-file-chooser +$ npm install @awesome-cordova-plugins/chooser-simple-file +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/chooser-simple-file/) + +Plugin Repo: [https://github.com/hc-oss/cordova-plugin-simple-file-chooser](https://github.com/hc-oss/cordova-plugin-simple-file-chooser) + +File chooser plugin for Cordova. + +The following must be added to config.xml to prevent crashing when selecting large files on Android: +```xml + + + + + +``` + +## Supported platforms + +- Android + - iOS + + + diff --git a/docs/plugins/magnetometer/README.md b/docs/plugins/magnetometer/README.md new file mode 100644 index 000000000..67af5b68c --- /dev/null +++ b/docs/plugins/magnetometer/README.md @@ -0,0 +1,20 @@ +# Device eMagnetometer + +``` +$ ionic cordova plugin add cordova-plugin-magnetometer +$ npm install @awesome-cordova-plugins/magnetometer +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/magnetometer/) + +Plugin Repo: [https://github.com/sdesalas/cordova-plugin-magnetometer](https://github.com/sdesalas/cordova-plugin-magnetometer) + +Requires Cordova plugin: `cordova-plugin-magnetometer`. For more info, please see the [Device Orientation docs](https://github.com/sdesalas/cordova-plugin-magnetometer). + +## Supported platforms + +- Android + - iOS + + + diff --git a/docs/plugins/market/README.md b/docs/plugins/market/README.md new file mode 100644 index 000000000..30539a27d --- /dev/null +++ b/docs/plugins/market/README.md @@ -0,0 +1,20 @@ +# Market + +``` +$ ionic cordova plugin add cordova-plugin-market +$ npm install @awesome-cordova-plugins/market +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/market/) + +Plugin Repo: [https://github.com/xmartlabs/cordova-plugin-market](https://github.com/xmartlabs/cordova-plugin-market) + +Opens an app's page in the market place (Google Play, App Store) + +## Supported platforms + +- Android + - iOS + + + diff --git a/docs/plugins/purchases/README.md b/docs/plugins/purchases/README.md index b1e52a71e..309f6277b 100644 --- a/docs/plugins/purchases/README.md +++ b/docs/plugins/purchases/README.md @@ -1,7 +1,7 @@ # Purchases ``` -$ ionic cordova plugin add cordova-plugin-purchases@2.3.0 +$ ionic cordova plugin add cordova-plugin-purchases@2.4.0 $ npm install @awesome-cordova-plugins/purchases ``` diff --git a/docs/plugins/smartlook/README.md b/docs/plugins/smartlook/README.md index 221eb8d71..f088d51e5 100644 --- a/docs/plugins/smartlook/README.md +++ b/docs/plugins/smartlook/README.md @@ -1,7 +1,5 @@ -# Smartlook - -``` -$ ionic cordova plugin add https://github.com/smartlook/cordova-smartlook.git +# SmartlookTimedCustomEventStart +plugin add https://github.com/smartlook/cordova-smartlook.git $ npm install @awesome-cordova-plugins/smartlook ``` diff --git a/docs/plugins/tealium/README.md b/docs/plugins/tealium/README.md index b8efae3ac..9ee3e4a3b 100644 --- a/docs/plugins/tealium/README.md +++ b/docs/plugins/tealium/README.md @@ -9,9 +9,9 @@ $ npm install @awesome-cordova-plugins/tealium Plugin Repo: [https://github.com/Tealium/cordova-plugin](https://github.com/Tealium/cordova-plugin) -This plugin provides a TypeScript wrapper around the [Tealium](https://www.tealium.com) Cordova plugin for Ionic Native. +This plugin does provides a wrapper around the Tealium Cordova Plugin for Ionic Native. -For full documentation, see [https://community.tealiumiq.com/t5/Mobile-Libraries/Tealium-for-Cordova/ta-p/17618](https://community.tealiumiq.com/t5/Mobile-Libraries/Tealium-for-Cordova/ta-p/17618) +For full documentation, see [https://docs.tealium.com/platforms/cordova/](https://docs.tealium.com/platforms/cordova/) ## Supported platforms diff --git a/docs/plugins/unvired-cordova-sdk/README.md b/docs/plugins/unvired-cordova-sdk/README.md index 31307f894..2527a077e 100644 --- a/docs/plugins/unvired-cordova-sdk/README.md +++ b/docs/plugins/unvired-cordova-sdk/README.md @@ -1,5 +1,5 @@ -# LoginParameters -SDK +# UnviredResult +a SDK ``` $ ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk