diff --git a/.gitignore b/.gitignore index af9ce43..13b79b7 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ docker dev docker-compose.admin.yml full_reload.sh +build-all.sh tmp ecosystem.config.js todo \ No newline at end of file diff --git a/README.md b/README.md index c471ffa..c9a2818 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,14 @@

-🌐 Website 📚 Docs 👾 Join Discord 🔥 Try Litlyx Cloud. It's Free. +📚 Docs 👾 Join Discord 🌐 Website 🔥 Try Litlyx Cloud. It's Free forever.

#

- The freshest, developer-friendly analytics tool.
- Litlyx is an open-source, self-hostable analytics solution for modern frameworks. Setup takes less than 30 seconds! + 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.

# @@ -25,7 +26,7 @@ ## 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. +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. ## Universal Installation @@ -33,25 +34,25 @@ Sign-up on [Litlyx.com](https://dashboard.litlyx.com) and create a project. Then ``` -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`. +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`. # All Javascript Runtimes -You can install Litlyx using `npm`, `pnpm`, `yarn` or any modern package managers: +You can install Litlyx using `npm`, `pnpm` or any modern package managers: ```sh 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 plug-in. Litlyx also works in serverless environments with Cloud (or Edge) Functions. +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.

-# Import +# Import using a package manager -Import litlyx-js library into your code: +First, Import litlyx-js library into your code: ```js import { Lit } from 'litlyx-js'; @@ -63,9 +64,9 @@ Once imported, you need to initialize Litlyx: 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`. +After initialization, Litlyx will automatically track web analytics such as `Page visits`, `Real-Time Online Users`, `Unique Vistors`, and many more. -# Track Custom Events +# Track Custom Events (Actions) You aren't just limited to the built-in KPIs. With Litlyx, you can create your own events to track in your project. @@ -104,11 +105,9 @@ curl -X POST "https://broker.litlyx.com/event" \ }' ``` -# Self-Hosting with Docker +# Self-hosting with docker -To self-host the Litlyx dashboard, first **fork** this repository. - -You can find our Docker images on DockerHub for more. +To self-host the Litlyx dashboard, first **clone** this repository. (Litlyx's Docker images are hosted on DockerHub). Then run the following command: ```bash @@ -117,9 +116,9 @@ 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 +## 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: 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. +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