diff --git a/README.md b/README.md index 1ceb910..4e14bb8 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,16 @@

- +

-🌐 Website 📚 Docs 🔥 Start for Free! +🌐 Website 📚 Docs 👾 Join Discord 🔥 Start for free!

-![GitHub Repo stars](https://img.shields.io/github/stars/Litlyx/litlyx) -![NPM Version](https://img.shields.io/npm/v/litlyx?logo=npm&color=orange) -![npm bundle size](https://img.shields.io/bundlephobia/min/litlyx) - -
- # -

- The easiest dev-centric analytics tool.
Litlyx is an open-source analytics solution for any JavaScript framework. Setup takes less then 30 seconds and just one line of code! + The easiest, developer-centric analytics tool.
+ Litlyxis an open-source, self-hostable analytics solution for modern framework. Setup takes less than 30 seconds!

# @@ -24,12 +18,12 @@

- +

# -## Pre-Requisites +## Pre-Requisites on 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. @@ -52,7 +46,7 @@ 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 enviroments with Cloud (or Edge) Functions.

- +

# Import @@ -92,14 +86,21 @@ Lit.event('click_on_buy_item', { Litlyx makes it easy for you to tailor your analytics to your project's needs. -# AI Data-Analyst -

- -

+# Fire Your First Event with cURL -Lit is an AI chatbot which you can use to compare data, query specific metadata, visualize charts, and much more with a simple conversation. +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. +```bash +curl -X POST "https://broker.litlyx.com/event" \ + -H "Content-Type: application/json" \ + -d '{ + "pid": "project_id", + "name": "testEvent1", + "metadata": "{\"test\": \"something\"}", + "website": "something", + "user +``` # Self-Hosting with Docker @@ -123,11 +124,11 @@ For more info read our [documentation](https://docs.litlyx.com). (will be improv # Join Discord -If you need more information, help, or want to provide general feedback, feel free to join us on the Litlyx [Discord](https://discord.gg/9cQykjsmWX) +If you need more information, interact with us or the community, help, or want to provide feedbacks, feel free to join us on the Litlyx [Discord](https://discord.gg/9cQykjsmWX) # Contributors -Every kind of contribution is accepted in this stage of the project. In the future we will improve the contributor onboarding process. +Every kind of contribution is accepted in this stage of the project. In the future we will improve the contributor onboarding process. ### Thank you! diff --git a/assets/bg.png b/assets/bg.png deleted file mode 100644 index 7517517..0000000 Binary files a/assets/bg.png and /dev/null differ diff --git a/assets/claim-t.png b/assets/claim-t.png deleted file mode 100644 index 66f325b..0000000 Binary files a/assets/claim-t.png and /dev/null differ diff --git a/assets/claim.png b/assets/claim.png new file mode 100644 index 0000000..7e44b16 Binary files /dev/null and b/assets/claim.png differ diff --git a/assets/dashboard-clip.png b/assets/dashboard-clip.png new file mode 100644 index 0000000..7662309 Binary files /dev/null and b/assets/dashboard-clip.png differ diff --git a/assets/devto1.png b/assets/devto1.png deleted file mode 100644 index 876b2cd..0000000 Binary files a/assets/devto1.png and /dev/null differ diff --git a/assets/screen.png b/assets/screen.png deleted file mode 100644 index 2e99fe1..0000000 Binary files a/assets/screen.png and /dev/null differ diff --git a/assets/tech.png b/assets/tech.png new file mode 100644 index 0000000..1720294 Binary files /dev/null and b/assets/tech.png differ diff --git a/assets/techs.png b/assets/techs.png deleted file mode 100644 index 9c6c9e6..0000000 Binary files a/assets/techs.png and /dev/null differ