From 4d45bc07abee480c6082a5e00f56f7efb20399a2 Mon Sep 17 00:00:00 2001 From: jcesarmobile Date: Fri, 9 Jun 2023 16:13:21 +0200 Subject: [PATCH] docs(README): Add plugin version table --- README.md | 57 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 36 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 3980d2b..7edd20b 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,20 @@ Capacitor community plugin for native market for Play Store/App Store. ## Maintainers -| Maintainer | GitHub | Social | Sponsoring Company | -| -----------| -------| -------| -------------------| -| Priyank Patel | [priyankpat](https://github.com/priyankpat) | [@priyankpat_](https://twitter.com/priyankpat_) | Ionic | +| Maintainer | GitHub | Social | Sponsoring Company | +| ------------- | ------------------------------------------- | ------------------------------------------------ | ------------------ | +| Priyank Patel | [priyankpat](https://github.com/priyankpat) | [@priyankpat\_](https://twitter.com/priyankpat_) | Ionic | Maintenance Status: Actively Maintained +## Plugin versions + +| Capacitor version | Plugin version | +| ----------------- | -------------- | +| 5.x | 5.x | +| 4.x | 4.x | +| < 3.x | 1.x | + ## Installation To use npm @@ -38,18 +46,25 @@ Android Platform: Register the plugin in your main activity: import com.getcapacitor.community.nativemarket.NativeMarket; public class MainActivity extends BridgeActivity { + @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // Initializes the Bridge - this.init(savedInstanceState, new ArrayList>() {{ - // Additional plugins you've installed go here - // Ex: add(TotallyAwesomePlugin.class); - add(NativeMarket.class); - }}); + this.init( + savedInstanceState, + new ArrayList>() { + { + // Additional plugins you've installed go here + // Ex: add(TotallyAwesomePlugin.class); + add(NativeMarket.class); + } + } + ); } } + ``` ## Configuration @@ -58,18 +73,18 @@ No configuration required for this plugin ## Supported methods -| Name | Android | iOS | Web -| :---- | :--- | :--- | :--- | -| openStoreListing | ✅ | ✅ | ❌ -| openDevPage | ✅ | ❌ | ❌ -| openCollection | ✅ | ❌ | ❌ -| openEditorChoicePage | ✅ | ❌ | ❌ -| search | ✅ | ✅ | ❌ +| Name | Android | iOS | Web | +| :------------------- | :------ | :-- | :-- | +| openStoreListing | ✅ | ✅ | ❌ | +| openDevPage | ✅ | ❌ | ❌ | +| openCollection | ✅ | ❌ | ❌ | +| openEditorChoicePage | ✅ | ❌ | ❌ | +| search | ✅ | ✅ | ❌ | ## Usage ```typescript -import { Plugins } from '@capacitor/core'; +import { Plugins } from "@capacitor/core"; const { NativeMarket } = Plugins; @@ -79,7 +94,7 @@ const { NativeMarket } = Plugins; * @returns void */ NativeMarket.openStoreListing({ - appId: 'com.example.app', + appId: "com.example.app", }); /** @@ -88,7 +103,7 @@ NativeMarket.openStoreListing({ * @returns void */ NativeMarket.openDevPage({ - devId: '5700313618786177705', + devId: "5700313618786177705", }); /** @@ -97,7 +112,7 @@ NativeMarket.openDevPage({ * @returns void */ NativeMarket.openCollection({ - name: 'featured', + name: "featured", }); /** @@ -106,7 +121,7 @@ NativeMarket.openCollection({ * @returns void */ NativeMarket.openEditorChoicePage({ - editorChoice: 'editorial_fitness_apps_us', + editorChoice: "editorial_fitness_apps_us", }); /** @@ -115,6 +130,6 @@ NativeMarket.openEditorChoicePage({ * @returns void */ NativeMarket.search({ - terms: 'capacitor', + terms: "capacitor", }); ```