Merged README docs.

Author: cengiz-pz

README.md

@@ -8,104 +8,181 @@
 
 # <img src="addon/icon.png" width="24"> Godot In-app Review Plugin
 
-Godot in-app review plugin provides access to in-app review functionality for Google Play Store on the Android platform and Apple App Store on the iOS platform through a unified GDScript interface.
+In-app Review Plugin provides access to in-app review functionality for Google Play Store on the Android platform and Apple App Store on the iOS platform through a unified GDScript interface.
 
-_This plugin has been moved under the umbrella of [Godot SDK Integrations](https://github.com/godot-sdk-integrations) organization in Github. Previously, the plugin was placed under three separate repositories: [Android](https://github.com/cengiz-pz/godot-android-inapp-review-plugin), [iOS](https://github.com/cengiz-pz/godot-ios-inapp-review-plugin), and [addon interface](https://github.com/cengiz-pz/godot-inapp-review-addon)._
+**Features:**
+- Enable in-app review for Google Play
+- Enable in-app review for App Store
 
-<br/>
+---
+
+## <img src="addon/icon.png" width="20"> Table of Contents
+- [Installation](#installation)
+- [Usage](#usage)
+- [Demo](#demo)
+- [Signals](#signals)
+- [Platform-Specific Notes](#platform-specific-notes)
+- [Links](#links)
+- [All Plugins](#all-plugins)
+- [Credits](#credits)
+- [Contributing](#contributing)
+
+---
+
+<a name="installation">
 
 ## <img src="addon/icon.png" width="20"> Installation
-_Before installing this plugin, make sure to uninstall any previous versions of the same plugin._
-
-_If installing both Android and iOS versions of the plugin in the same project, then make sure that both versions use the same addon interface version._
-
-There are 2 ways to install this plugin into your project:
-- Through the Godot Editor's AssetLib
-- Manually by downloading archives from Github
-
-### <img src="addon/icon.png" width="18"> Installing via AssetLib
-Steps:
-- search for and select the `In-app Review` plugin in Godot Editor
-- click `Download` button
-- on the installation dialog...
-	- keep `Change Install Folder` setting pointing to your project's root directory
-	- keep `Ignore asset root` checkbox checked
-	- click `Install` button
-- enable the plugin via the `Plugins` tab of `Project->Project Settings...` menu, in the Godot Editor
-
-#### <img src="addon/icon.png" width="16"> Installing both Android and iOS versions of the plugin in the same project
-When installing via AssetLib, the installer may display a warning that states "_[x number of]_ files conflict with your project and won't be installed." You can ignore this warning since both versions use the same addon code.
-
-### <img src="addon/icon.png" width="18"> Installing manually
-Steps:
-- download release archive from Github
-- unzip the release archive
-- copy to your Godot project's root directory
-- enable the plugin via the `Plugins` tab of `Project->Project Settings...` menu, in the Godot Editor
+
+**Uninstall previous versions** before installing.
+If using both Android & iOS, ensure **same addon interface version**.
+
+**Options:**
+1. **AssetLib**
+	- Search for `In-app Review`
+	- Click `Download` → `Install`
+	- Install to project root, `Ignore asset root` checked
+	- Enable via **Project → Project Settings → Plugins**
+	- Ignore file conflict warnings when installing both versions
+2. **Manual**
+	- Download release from GitHub
+	- Unzip to project root
+	- Enable via **Plugins** tab
+
+---
+
+<a name="usage">
 
 ## <img src="addon/icon.png" width="20"> Usage
 Add an `InappReview` node to your scene and follow the following steps:
-- register listeners for the following signals emitted from the `InappReview` node
-	- `review_info_generated`
-	- `review_info_generation_failed`
-	- `review_flow_launched`
-	- `review_flow_launch_failed`
+- register listeners for the [all signals](#signals) emitted from the `InappReview` node
 - call the `generate_review_info()` method of the `InappReview` node
 - when the `review_info_generated` signal is received, call the `launch_review_flow()` of the `InappReview` node
-	- Google Play Store API will display a dialog
+	- Depending on platform Google Play or App Store API will display a review dialog
 	- Dialog may not be displayed if the review flow was launched recently
 - normal app functionality can resume when `review_flow_launched` signal is received
 
-## <img src="addon/icon.png" width="20"> Demo
-The demo app's only purpose is to provide sample code. Since the demo app is not registered with the Google Play store, the Google Play in-app review dialog will not be displayed.
+---
 
-<br/><br/>
+<a name="demo">
 
+## <img src="addon/icon.png" width="20"> Demo
+The demo app's only purpose is to provide sample code. Since the demo app is not registered with the Google Play store or App Store, the in-app review dialog will not be displayed.
+	
 ---
 
-# <img src="addon/icon.png" width="24"> Android In-app Review Plugin
+<a name="signals">
 
-<p align="center">
-	<img width="256" height="256" src="demo/assets/inappreview-android.png">
-</p>
+## <img src="addon/icon.png" width="20"> Signals
 
+- `review_info_generated`: Emitted when info generation succeeded.
+- `review_info_generation_failed`: Emitted when info generation failed.
+- `review_flow_launched`: Emitted when review flow launched.
+- `review_flow_launch_failed`: Emitted when review flow launch failed.
 
-## [Android-specific Documentation](android/README.md)
-## [AssetLib Entry](https://godotengine.org/asset-library/asset/2549)
+---
 
-<br/><br/>
+<a name="platform-specific-notes">
 
----
+## <img src="addon/icon.png" width="20"> Platform-Specific Notes
 
-# <img src="addon/icon.png" width="24"> iOS In-app Review Plugin
+### Android
+- **Build:** [Create custom Android gradle build](https://docs.godotengine.org/en/stable/tutorials/export/android_gradle_build.html).
+- **Registration:** App must be registered with the Google Play.
+- **Troubleshooting:**
+  - Logs: `adb logcat | grep 'godot'` (Linux), `adb.exe logcat | select-string "godot"` (Windows)
+  - _No review dialog shown_: Check [Google Play quotas](https://developer.android.com/guide/playcore/in-app-review#quotas)
 
-<p align="center">
-	<img width="256" height="256" src="demo/assets/inappreview-ios.png">
-</p>
+### iOS
+- **Registration:** App must be registered with the App Store.
+- **Troubleshooting:**
+	- View XCode logs while running the game for troubleshooting.
+	- See [Godot iOS Export Troubleshooting](https://docs.godotengine.org/en/stable/tutorials/export/exporting_for_ios.html#troubleshooting).
 
-## [iOS-specific Documentation](ios/README.md)
-## [AssetLib Entry](https://godotengine.org/asset-library/asset/2906)
+---
 
-<br/><br/>
+<a name="links">
+
+# <img src="addon/icon.png" width="20"> Links
+
+- [AssetLib Entry Android](https://godotengine.org/asset-library/asset/2549)
+- [AssetLib Entry iOS](https://godotengine.org/asset-library/asset/2906)
 
 ---
+
+<a name="all-plugins">
+
 # <img src="addon/icon.png" width="24"> All Plugins
 
 | Plugin | Android | iOS |
-| :--- | :---: | :---: |
+| :---: | :--- | :--- |
 | [Notification Scheduler](https://github.com/godot-sdk-integrations/godot-notification-scheduler) | ✅ | ✅ |
 | [Admob](https://github.com/godot-sdk-integrations/godot-admob) | ✅ | ✅ |
 | [Deeplink](https://github.com/godot-sdk-integrations/godot-deeplink) | ✅ | ✅ |
 | [Share](https://github.com/godot-sdk-integrations/godot-share) | ✅ | ✅ |
 | [In-App Review](https://github.com/godot-sdk-integrations/godot-inapp-review) | ✅ | ✅ |
 
-<br/><br/>
-
 ---
+
+<a name="credits">
+
 # <img src="addon/icon.png" width="24"> Credits
 
 Developed by [Cengiz](https://github.com/cengiz-pz)
 
 iOS part is based on [DrMoriarty](https://github.com/DrMoriarty)'s [Godot iOS Plugin Template](https://github.com/DrMoriarty/godot_ios_plugin_template)
 
 Original repository: [Godot In-app Review Plugin](godot-sdk-integrations/godot-inapp-review)
+
+---
+
+<a name="contributing">
+
+# <img src="addon/icon.png" width="24"> Contributing
+
+This section provides information on how to build the plugin for contributors.
+
+---
+
+## <img src="addon/icon.png" width="20"> iOS
+
+### Prerequisites
+
+- [Install SCons](https://scons.org/doc/production/HTML/scons-user/ch01s02.html)
+- [Install CocoaPods](https://guides.cocoapods.org/using/getting-started.html)
+
+---
+
+### Build
+
+- Run `./script/build.sh -A <godot version>` initially to run a full build
+- Run `./script/build.sh -cgA <godot version>` to clean, redownload Godot, and rebuild
+- Run `./script/build.sh -ca` to clean and build without redownloading Godot
+- Run `./script/build.sh -cb -z4.0` to clean and build plugin without redownloading Godot and package in a zip archive as version 4.0
+- Run `./script/build.sh -h` for more information on the build script
+
+___
+
+## <img src="addon/icon.png" width="20"> Install Script
+
+- Run `./script/install.sh -t <target directory> -z <path to zip file>` install plugin to a Godot project.
+- Example `./script/install.sh -t demo -z build/release/DeeplinkPlugin-v4.0.zip` to install to demo app.
+
+___
+
+## <img src="addon/icon.png" width="20"> Libraries
+
+Library archives will be created in the `build/release` directory.
+
+---
+
+## <img src="addon/icon.png" width="20"> Android
+
+### Build
+
+**Options:**
+1. Use [Android Studio](https://developer.android.com/studio) to build via **Build->Assemble Project** menu
+	- Switch **Active Build Variant** to **release** and repeat
+	- Run **packageDistribution** task to create release archive
+2. Use project-root-level **build.sh** script
+	- `./script/build.sh -ca` - clean existing build, do a debug build for Android
+	- `./script/build.sh -carz` - clean existing build, do a release build for Android, and create archive