Updated README.md

This commit is contained in:
FalsinSoft 2019-02-03 23:18:26 +01:00
parent 2561eb7400
commit 3df4cc5158
2 changed files with 11 additions and 30 deletions

View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
<title>VDoc - Responsive Documentation HTML Template</title>
<title>QtAndroidTools library documentation</title>
<meta name="description" content="Free responsive HTML template for your documentation">
<meta name="author" content="valthemes.com">
<meta name="format-detection" content="telephone=no">

View File

@ -1,46 +1,27 @@
# QtAndroidTools
QtAndroidTools is a library that allows to simplify access to some native Android features from QML.
**Library documentation [here](https://falsinsoft.github.io/QtAndroidTools/Documentation/)**
# The tools
**ApkExpansionFiles**
Help in manage the apk expansion files download
[Documentation](https://falsinsoft.blogspot.com/2019/01/qtandroidtools-apkexpansionfiles.html)
**AppPermissions**
Allow to request Android app permissions in an easier way
[Documentation](https://falsinsoft.blogspot.com/2019/01/qtandroidtools-apppermissions.html)
**ApkInfo**
Return info about the apk containing the executed app
[Documentation](https://falsinsoft.blogspot.com/2019/01/qtandroidtools-apkinfo.html)
**BatteryState**
Allow monitoring the battery level and state
[Documentation](https://falsinsoft.blogspot.com/2019/01/qtandroidtools-batterystate.html)
**SignalStrength**
Allow monitoring the strength of the phone signal
[Documentation](https://falsinsoft.blogspot.com/2019/01/qtandroidtools-signalstrength.html)
**AdMobBanner**
Allow to show AdMob banner inside QML app
[Documentation](https://falsinsoft.blogspot.com/2019/01/qtandroidtools-admobbanner.html)
# How To Integrate
- Place QtAndroidTools lib to your project dir and include it in .pro file
```
include(QtAndroidTools/QtAndroidTools.pri)
```
**AdMobInterstitial**
Allow to show AdMob interstitial inside QML app
- Assign in you .pro file varialble ANDROID_PACKAGE_SOURCE_DIR before include QtAndroidTools/QtAndroidTools.pri, for ex.
```
ANDROID_PACKAGE_SOURCE_DIR = $$PWD/android
```
**ApkInfo**
Return info about the apk containing the executed app
- In the main() body insert the call for initialize the library
```
QtAndroidTools::InitializeQmlTools();
```
**BatteryState**
Allow monitoring the battery level and state
**IMPORTANT NOTE:** The library .pri check if java sources are already present into android/src folder, if no copy the library files. In case you are updating the library remember to remove these java files to be sure having always the new java versions code.
**SignalStrength**
Allow monitoring the strength of the phone signal