docs: update README.md #82

README.md

@@ -1,104 +1,158 @@
-[![Download Asset Library](https://img.shields.io/badge/Download-Asset%20Library-darkgreen?style=for-the-badge)](https://godotengine.org/asset-library/asset/1108)
-![Stars](https://img.shields.io/github/stars/Poing-Studios/godot-admob-editor?style=for-the-badge)
-![License](https://img.shields.io/github/license/Poing-Studios/godot-admob-editor?style=for-the-badge)
+[![Version](https://img.shields.io/github/v/tag/Poing-Studios/godot-admob-plugin?label=Version)](https://github.com/Poing-Studios/godot-admob-plugin/releases)
+[![Download Asset Library](https://img.shields.io/badge/Download-Asset%20Library-darkgreen)](https://godotengine.org/asset-library/asset/1108)
+![Stars](https://img.shields.io/github/stars/Poing-Studios/godot-admob-plugin?style=social)
+![License](https://img.shields.io/github/license/Poing-Studios/godot-admob-plugin)
 
 # Godot AdMob Editor Plugin
 
 This addon provides an easy and beautiful way to configure AdMob directly through the editor. Supports [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android) and [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios).
 
-### [Installation and Usage Tutorial](https://www.youtube.com/watch?v=ZnlH3INcAGs)
+- Video Tutorial - Soon
 
 # Installation
 
 Godot Asset Library (recommended):
 1. Find the AdMob plugin by `poing.studios` \
    <img height=100 src="static/asset_library.png">
 2. Click Download and Install
-3. Enable in Project→Project Settings→Plugins
-4. Install [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android) and/or [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios)
+3. Enable in Project→Project Settings→Plugins.
+4. Download [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android) and/or [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios) in `Project→Tools→AdMob Download Manager→Android/iOS→LatestVersion`.
+5. To know how to deploy, check the README.md of [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android/#usage) and/or [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios/#usage).
 
 Manual install for custom versions:
 1. Pick a [specific version](https://github.com/Poing-Studios/godot-admob-editor/tags) from tags
 2. Download and extract as a `.zip` or `.tar.gz`
 3. Copy the extracted `addons/admob` folder into `res://addons` on your project
-4. Install [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android) and/or [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios)
+4. Download [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android) and/or [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios) in `Project→Tools→AdMob Download Manager→Android/iOS→LatestVersion`.
+5. To know how to deploy, check the README.md of [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android/#usage) and/or [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios/#usage).
 
-# Usage
+# How to use
+After installation, all the methods will be available for use in any `.gd` script.
 
-After installation, the singleton `MobileAds` will be available. Try it out by calling `MobileAds.load_banner()`!
-
-# API
-
-### Methods:
+# Examples
 
+## Initialize AdMob
+```gdscript
+func _ready() -> void:
+	#just need to call once
+	MobileAds.initialize()
+```
+## Banner Ads
+### Load (will automatically shows)
+```gdscript
+# button signal on scene
+func _on_load_banner_pressed() -> void:
+	var unit_id : String
+	if OS.get_name() == "Android":
+		unit_id = "ca-app-pub-3940256099942544/6300978111"
+	elif OS.get_name() == "iOS":
+		unit_id = "ca-app-pub-3940256099942544/6300978111"
+
+	var ad_view := AdView.new(unit_id, AdSize.BANNER, AdPosition.Values.TOP)
+	ad_view.load_ad(AdRequest.new())
+```
+## Interstitial Ads
+### Load
+```gdscript
+var interstitial_ad : InterstitialAd
+var interstitial_ad_load_callback := InterstitialAdLoadCallback.new()
+func _ready():
+	interstitial_ad_load_callback.on_ad_failed_to_load = on_interstitial_ad_failed_to_load
+	interstitial_ad_load_callback.on_ad_loaded = on_interstitial_ad_loaded
+
+# button signal on scene
+func _on_load_interstitial_pressed() -> void:
+	var unit_id : String
+	if OS.get_name() == "Android":
+		unit_id = "ca-app-pub-3940256099942544/1033173712"
+	elif OS.get_name() == "iOS":
+		unit_id = "ca-app-pub-3940256099942544/4411468910"
+
+	InterstitialAdLoader.new().load(unit_id, AdRequest.new(), interstitial_ad_load_callback)
+
+func on_interstitial_ad_failed_to_load(adError : LoadAdError) -> void:
+	print(adError.message)
+
+func on_interstitial_ad_loaded(interstitial_ad : InterstitialAd) -> void:
+	self.interstitial_ad = interstitial_ad
+```
+### Show
 ```gdscript
-void load_banner(ad_unit_name = "standard")
-void load_interstitial(ad_unit_name = "standard")
-void load_rewarded(ad_unit_name = "standard")
-void load_rewarded_interstitial(ad_unit_name = "standard")
-
-void destroy_banner()
-void show_banner()
-void hide_banner()
-void show_interstitial()
-void show_rewarded()
-void show_rewarded_interstitial()
-
-void request_user_consent()
-void reset_consent_state(will_request_user_consent = false)
-
-int get_banner_width()
-int get_banner_width_in_pixels()
-int get_banner_height()
-int get_banner_height_in_pixels()
-bool get_is_banner_loaded()
-bool get_is_interstitial_loaded()
-bool get_is_rewarded_loaded()
-bool get_is_rewarded_interstitial_loaded()
+# button signal on scene
+func _on_show_pressed():
+	if interstitial_ad:
+		interstitial_ad.show()
 ```
 
-### Signals:
+## Rewarded Ads
+### Load
+```gdscript
+var rewarded_ad : RewardedAd
+var rewarded_ad_load_callback := RewardedAdLoadCallback.new()
+
+func _ready():
+	rewarded_ad_load_callback.on_ad_failed_to_load = on_rewarded_ad_failed_to_load
+	rewarded_ad_load_callback.on_ad_loaded = on_rewarded_ad_loaded
+
+# button signal on scene
+func _on_load_interstitial_pressed() -> void:
+	var unit_id : String
+	if OS.get_name() == "Android":
+		unit_id = "ca-app-pub-3940256099942544/5224354917"
+	elif OS.get_name() == "iOS":
+		unit_id = "ca-app-pub-3940256099942544/1712485313"
+
+	RewardedAdLoader.new().load(unit_id, AdRequest.new(), rewarded_ad_load_callback)
+
+func on_rewarded_ad_failed_to_load(adError : LoadAdError) -> void:
+	print(adError.message)
+	
+func on_rewarded_ad_loaded(rewarded_ad : RewardedAd) -> void:
+	self.rewarded_ad = rewarded_ad
+```
+### Show
+```gdscript
+# button signal on scene
+func _on_show_pressed():
+	if rewarded_ad:
+		rewarded_ad.show()
+```
 
+## Rewarded Interstitial Ads
+### Load
 ```gdscript
-initialization_complete(status, adapter_name)
-
-consent_form_dismissed()
-consent_status_changed(consent_status_message)
-consent_form_load_failure(error_code, error_message)
-consent_info_update_success(consent_status_message)
-consent_info_update_failure(error_code, error_message)
-
-banner_loaded()
-banner_failed_to_load(error_code)
-banner_opened()
-banner_clicked()
-banner_closed()
-banner_recorded_impression()
-banner_destroyed()
-
-interstitial_failed_to_load(error_code)
-interstitial_loaded()
-interstitial_failed_to_show(error_code)
-interstitial_opened()
-interstitial_clicked()
-interstitial_closed()
-interstitial_recorded_impression()
-
-rewarded_ad_failed_to_load(error_code)
-rewarded_ad_loaded()
-rewarded_ad_failed_to_show(error_code)
-rewarded_ad_opened()
-rewarded_ad_clicked()
-rewarded_ad_closed()
-rewarded_ad_recorded_impression()
-
-rewarded_interstitial_ad_failed_to_load(error_code)
-rewarded_interstitial_ad_loaded()
-rewarded_interstitial_ad_failed_to_show(error_code)
-rewarded_interstitial_ad_opened()
-rewarded_interstitial_ad_clicked()
-rewarded_interstitial_ad_closed()
-rewarded_interstitial_ad_recorded_impression()
-
-user_earned_rewarded(currency, amount)
+var rewarded_interstitial_ad : RewardedInterstitialAd
+var rewarded_interstitial_ad_load_callback := RewardedInterstitialAdLoadCallback.new()
+
+func _ready():
+	rewarded_interstitial_ad_load_callback.on_ad_failed_to_load = on_rewarded_interstitial_ad_failed_to_load
+	rewarded_interstitial_ad_load_callback.on_ad_loaded = on_rewarded_interstitial_ad_loaded
+
+# button signal on scene
+func _on_load_interstitial_pressed() -> void:
+	var unit_id : String
+	if OS.get_name() == "Android":
+		unit_id = "ca-app-pub-3940256099942544/5354046379"
+	elif OS.get_name() == "iOS":
+		unit_id = "ca-app-pub-3940256099942544/6978759866"
+	
+	RewardedInterstitialAdLoader.new().load(unit_id, AdRequest.new(), rewarded_interstitial_ad_load_callback)
+
+func on_rewarded_interstitial_ad_failed_to_load(adError : LoadAdError) -> void:
+	print(adError.message)
+	
+func on_rewarded_interstitial_ad_loaded(rewarded_interstitial_ad : RewardedInterstitialAd) -> void:
+	self.rewarded_interstitial_ad = rewarded_interstitial_ad
 ```
+### Show
+```gdscript
+# button signal on scene
+func _on_show_pressed():
+	if rewarded_interstitial_ad:
+		rewarded_interstitial_ad.show(on_user_earned_reward_listener)
+```
+
+# Documentation
+For a complete documentation of this Plugin including how to mediation: [check here](docs).
+
+Alternatively, you can check the docs of AdMob itself of [Android](https://developers.google.com/admob/android/quick-start) and [iOS](https://developers.google.com/admob/ios/quick-start).

docs/README.md

@@ -0,0 +1 @@
+# UNDER CONSTRUCTION