diff --git a/.dockerignore b/.dockerignore
deleted file mode 100644
index b96f0d5..0000000
--- a/.dockerignore
+++ /dev/null
@@ -1,26 +0,0 @@
-shared/node_modules
-shared/.output
-
-scripts/node_modules
-
-lyx-ui/node_modules
-lyx-ui/.nuxt
-lyx-ui/.output
-
-producer/node_modules
-producer/scripts/start_dev.js
-producer/ecosystem.config.cjs
-
-consumer/node_modules
-consumer/scripts/start_dev.js
-consumer/ecosystem.config.cjs
-
-dashboard/node_modules
-dashboard/.nuxt
-dashboard/.output
-dashboard/explains
-dashboard/tests
-dashboard/.env
-dashboard/winston-*.ndjson
-dashboard/ecosystem.config.cjs
-
diff --git a/.gitignore b/.gitignore
index 13b79b7..c491e92 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,11 +1,4 @@
-steps
-PROCESS_EVENT
-**/node_modules/
-docker
-dev
-docker-compose.admin.yml
-full_reload.sh
-build-all.sh
+node_modules
+todo
tmp
-ecosystem.config.js
-todo
\ No newline at end of file
+cluster
diff --git a/README.md b/README.md
index c9a2818..e7046de 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,14 @@
#
- Litlys is a modern, developer-friendly, cookie-free analytics tool.
- Setup takes less than 30 seconds! Completely self-hostable with docker.
- Alternative to Google Analytics, Matomo, Umami, Plausible & Simple Analytics.
+ Litlys is the easiest analytics tool you will ever use. It is fast, modern and completely cookie free.
+ Install in under 30 seconds. Self host with Docker or use our hosted cloud.
+ A powerful alternative to Google Analytics 4, Posthog and Mixpanel.
#
@@ -19,24 +19,25 @@
- 
+ 
#
## 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.
+Sign up on [Litlyx.com](https://dashboard.litlyx.com) and create a project. Then use your `workspace_id` to connect Litlyx to your website.
## Universal Installation
```html
-
+
```
-Importing Litlyx with a direct script instantly starts tracking `Visits`, `Top Pages`, `Bouncing Rate`, `Real-Time Online Users`, `Unique Visitors`, `Countries`, and `Average Session Duration`.
+This minimal setup is all you need to start tracking visitors on your website or web apps with ease.
-# All Javascript Runtimes
+# Intergrate with everything
You can install Litlyx using `npm`, `pnpm` or any modern package managers:
@@ -44,37 +45,35 @@ You can install Litlyx using `npm`, `pnpm` or any modern package managers:
npm i litlyx-js
```
-Litlyx natively works with all JavaScript / TypeScript frameworks. You can use Litlyx in all WordPress Websites by injecting JS code using a third party plug-in.
+Litlyx works with all modern JavaScript and TypeScript frameworks. You can also use Litlyx on any WordPress website by injecting the script with a third party plugin.
-
- 
-
+ 
# Import using a package manager
-First, Import litlyx-js library into your code:
+First, import the litlyx-js library:
```js
import { Lit } from 'litlyx-js';
```
-Once imported, you need to initialize Litlyx:
+Then initialize Litlyx:
```js
-Lit.init('your_project_id');
+Lit.init('your_workspace_id');
```
-After initialization, Litlyx will automatically track web analytics such as `Page visits`, `Real-Time Online Users`, `Unique Vistors`, and many more.
+Once initialized, Litlyx automatically tracks page visits, real time users, unique visitors and much more.
-# Track Custom Events (Actions)
+# 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.
+You can track your own custom events with Litlyx.
```js
Lit.event('click_on_buy_item');
```
+If you need more detailed information, you can add `metadata`:
-If you want more specific tracking, you can use the `metadata` field, like this:
```js
Lit.event('click_on_buy_item', {
@@ -86,18 +85,17 @@ Lit.event('click_on_buy_item', {
});
```
-Litlyx makes it easy for you to tailor your analytics to your project's needs.
-
+Litlyx makes it easy to adapt your analytics to your project.
# Fire Your First Event with cURL
-Want to quickly see how Litlyx works with events? Use the cURL command below to send a test event. Just replace the `project_id` with your actual project ID in your terminal.
+Use the command below to send a test event. Replace `workspace_id` with your project ID.
```bash
curl -X POST "https://broker.litlyx.com/event" \
-H "Content-Type: application/json" \
-d '{
- "pid": "project_id",
+ "pid": "workspace_id",
"name": "testEvent1",
"metadata": "{\"test\": \"something\"}",
"website": "something",
@@ -107,21 +105,22 @@ curl -X POST "https://broker.litlyx.com/event" \
# Self-hosting with docker
-To self-host the Litlyx dashboard, first **clone** this repository. (Litlyx's Docker images are hosted on DockerHub).
+To self host the Litlyx dashboard, first clone this repository. Litlyx Docker images are hosted on DockerHub.
+
+Run the following command:
-Then run the following command:
```bash
docker-compose up
```
-at localhost:3000 you will see your own instance of the Litlyx Dashboard.
+At localhost:3000 you will see your own instance of the Litlyx dashboard.
## Forward data to your self-hosted instance with script tag
To forward your data on your self-hosted instance, you need to set up the following variables: `data-host`, `data-port`, `data-secure`(`true` if it is HTTPS or `false` if it is HTTP).
```html
-