diff --git a/README.md b/README.md
index 5e474c7..4708841 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,13 @@
#
- The easiest, developer-centric analytics tool.
- Litlyxis an open-source, self-hostable analytics solution for modern framework. Setup takes less than 30 seconds!
+ The freshest, developer-friendly analytics tool.
+ Litlyx is an open-source, self-hostable analytics solution for modern frameworks. Setup takes less than 30 seconds!
#
@@ -23,21 +23,21 @@
#
-## Pre-Requisites on Cloud Version
+## Get Started on our Cloud Version
Sign-up on [Litlyx.com](https://dashboard.litlyx.com) and create a project. Then simply use your project_id to connect Litlyx to your website OR Self-Host Litlyx with Docker.
## Universal Installation
```html
-
+
```
-Importing Litlyx with a direct script instantly starts tracking 10 KPIs, including `Page visits`, `Browsers`, `Devices`, `Operating Systems`, `Real-Time Online Users`, `Unique Sessions`, `Countries`, and `Average Session Time`.
+Importing Litlyx with a direct script instantly starts tracking `Page visits`, `Browsers`, `Devices`, `Operating Systems`, `Bouncing Rate`, `Real-Time Online Users`, `Unique Sessions`, `Countries`, and `Average Session Time`.
# All Javascript Runtimes
-You can install Litlyx using `npm`, `yarn`, or `pnpm`:
+You can install Litlyx using `npm`, `pnpm`, `yarn` or any modern package managers:
```sh
npm i litlyx-js
@@ -65,7 +65,7 @@ Lit.init('your_project_id');
After initialization, Litlyx will automatically track analytics such as `Page visits`, `Browsers`, `Devices`, `Operating Systems`, `Real-Time Online Users`, `Unique Sessions`, `Countries`, and `Average Session Time`.
-# Custom Events
+# Track Custom Events
You aren't just limited to the built-in KPIs. With Litlyx, you can create your own events to track in your project.
@@ -80,6 +80,7 @@ Lit.event('click_on_buy_item', {
metadata: {
'product-name': 'Coca-Cola',
'price': 1.50,
+ 'currency': 'EUR'
}
});
```
@@ -119,6 +120,19 @@ docker-compose up
at localhost:3000 you will see your own instance of the Litlyx Dashboard.
+## Forward data to your local instance with script tag
+
+To forward your data on your self-hosted instance, you need to set up the following variables: add your `data-host`, add your `data-port`, and add your `data-secure`, setting it to true if it is HTTPS, and false if it is HTTP.
+
+```html
+
+```
+
# Official Docs
For more info read our [documentation](https://docs.litlyx.com). (will be improved in the near future using Mintlify!)
diff --git a/assets/claim.png b/assets/claim.png
index 7e44b16..f22d9dd 100644
Binary files a/assets/claim.png and b/assets/claim.png differ