From 4254ceea51fdfa1ed2294e7901871bed1ce1535b Mon Sep 17 00:00:00 2001
From: mohiit1502 <mohiit1502@gmail.com>
Date: Wed, 4 Sep 2024 21:50:01 +0530
Subject: [PATCH] Added ReadMe

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1d2b1c0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Generic analytics lib collector
+## Uses an analyticsrc file to determine how to collect analytics
+
+### Eg analyticsrc.json:
+```
+{
+  "trackEvents": ["click"],
+  "hostProjectName": "@armco/armory-react-components",
+  "analyticsLogEndpoint": "http://localhost:5004/api/events/add",
+  "analyticsTagEndpoint": "http://localhost:5004/api/events/tag"
+}
+```
+### It can track default set of interactive events like click, select, page etc.
+### It also exposes an API that can be used to explicitly track custom events from within host application.