Added ReadMe
This commit is contained in:
14
README.md
Normal file
14
README.md
Normal file
@@ -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.
|
||||
Reference in New Issue
Block a user