From 0958c8cd8b88a6a95873ea89af6c24394a1bb72f Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Sat, 25 Feb 2017 00:36:12 +0100 Subject: [PATCH] updated README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 62eabce..de74a2f 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,21 @@ Google Analytics everywhere ## Usage Use TypeScript for best in class instellisense. +### Why does this package exist? +Tracking users in webapps is common. We use Google Analytics to gain insight in aho is using what +and where to spend resources for best efficiency. + +Doing the same stuff in apps can be a bit of a hassle. Unnecessary dependencies tend to make apps slow that do any kind of analtics. +Say hello to smartanalytics. It features a very slim dependency tree using the native node request module to send posts to Google Analytics. + +### How do I use this package? + +```javascript +import {AnalyticsAccount} from 'smartanalytics' +let myAnalyticsAccount = new AnalyticsAccount('My App Name', 'UA-XXXXXX-Y') +myAnalyticsAccount.sendEvent('npmtool', 'install', 'somelabel') +``` + For further information read the linked docs at the top of this README. > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)