summaryrefslogtreecommitdiffstats
path: root/libraries/ganalytics/README.md
diff options
context:
space:
mode:
authorPetr Mrázek <peterix@gmail.com>2016-11-20 12:04:29 +0100
committerPetr Mrázek <peterix@gmail.com>2016-11-20 12:04:29 +0100
commit2ec15c32e4419c94995f78b1d1ef8790e71b3317 (patch)
tree986f1212e9fa3156a532e912736338edf69964a7 /libraries/ganalytics/README.md
parent69be23c5f629884465dec98efcb9d5a2678b4df5 (diff)
downloadMultiMC-2ec15c32e4419c94995f78b1d1ef8790e71b3317.tar
MultiMC-2ec15c32e4419c94995f78b1d1ef8790e71b3317.tar.gz
MultiMC-2ec15c32e4419c94995f78b1d1ef8790e71b3317.tar.lz
MultiMC-2ec15c32e4419c94995f78b1d1ef8790e71b3317.tar.xz
MultiMC-2ec15c32e4419c94995f78b1d1ef8790e71b3317.zip
NOISSUE import google analytics from third party
See: https://github.com/HSAnet/qt-google-analytics Sadly, the API and its internals are not acceptable and it needs changes upstream likely wouldn't allow.
Diffstat (limited to 'libraries/ganalytics/README.md')
-rw-r--r--libraries/ganalytics/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/libraries/ganalytics/README.md b/libraries/ganalytics/README.md
new file mode 100644
index 00000000..d7e1e33c
--- /dev/null
+++ b/libraries/ganalytics/README.md
@@ -0,0 +1,34 @@
+qt-google-analytics
+================
+
+Qt5 classes for providing google analytics usage in a Qt/QML application.
+
+## Building
+Include ```qt-google-analytics.pri``` in your .pro file.
+
+## Using
+Please make sure you have set your application information using ```QApplication::setApplicationName``` and ```QApplication::setApplicationVersion```.
+
+### In C++:
+```
+GAnalytics tracker("UA-my-id");
+tracker.sendScreenView("Main Screen");
+```
+
+### In QtQuick:
+Register the class on the C++ side using ```qmlRegisterType<GAnalytics>("analytics", 0, 1, "Tracker");```
+```
+Tracker {
+ id: tracker
+ trackingID: "UA-my-id"
+}
+
+[...]
+tracker.sendScreenView("Main Screen")
+```
+
+There is also an example application in the examples folder.
+
+## License
+Copyright (c) 2014-2016, University of Applied Sciences Augsburg.
+All rights reserved. Distributed under the terms and conditions of the BSD License. See separate LICENSE.txt.