Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

Why Swetrix, Getting Started and Selfhosting sections

Blue Mouse502e469bb11f
diff --git a/README.md b/README.md
index 1087c0879..cc5323b29 100644
--- a/README.md
+++ b/README.md
@@ -42,13 +42,50 @@ We are a bootstrapped company that is passionate about privacy and open source,
## ✨ Why Swetrix?
-TODO
+We've been building Swetrix since 2021 with a goal to make web analytics simple and respectful of your users' privacy.
+
+- **Privacy‑first and cookieless**: GDPR‑compliant by design. We don't use cookies, cross-device tracking, all the data is stored anonymised. Read more in our [Data Policy](https://swetrix.com/data-policy) page.
+- **Lightweight and fast**: a small tracking script and a snappy, real‑time dashboard.
+- **Core insights that matter**: top pages, geolocation, map visualisation, devices, traffic sources and UTM campaigns.
+- **Custom events and properties**: track conversions, sales, or key user actions with your own semantics.
+- **Session analytics and user flows**: understand journeys and behaviour across your site.
+- **Funnels**: visualise drop‑offs and improve conversion rates.
+- **Performance monitoring**: real‑user metrics (e.g. TTFB, DNS, TLS, render) to keep sites fast.
+- **Error tracking**: capture client‑side errors with details and aggregated views.
+- **Shareable analytics**: public or password‑protected dashboards; invite teammates with roles, or manage access with organisations.
+- **Data portability**: export to CSV and access data via our [developer API](https://docs.swetrix.com/statistics-api).
+- **Extensible (Cloud)**: extensions marketplace to enhance dashboards and workflows.
+- **Alerts & notifications (Cloud)**: get notified on thresholds via Slack, Telegram or Discord.
+- Open source and self‑hostable, with a fully managed EU‑hosted Cloud option.
## 🚀 Getting Started
+The easiest way to get started with Swetrix is by using [our cloud service](https://swetrix.com). We do all the work for you: hosting, maintenance, backups, worldwide CDN, etc. Using Cloud you still own the data, you can export it or delete it at any time you want. It's GDPR‑compliant, hosted in the EU (Germany), with a free trial available.
+
+We're an independent and bootstrapped company, your subscription to Swetrix Cloud directly supports maintenance and development of the project, which eventually makes it better.
+
+- Start using Cloud: https://swetrix.com (starts at $19/mo with a free trial available)
+- Explore docs: https://docs.swetrix.com
+
### Selfhosting
-If you want to self-host Swetrix, please refer to our official [self-hosting documentation](https://docs.swetrix.com/selfhosting/how-to).
+Prefer to run it yourself? Swetrix Community Edition (CE) ships the same core analytics: privacy‑friendly traffic stats, custom events, sessions, funnels, performance and error tracking. Use Docker to deploy the API and UI, connect MySQL/ClickHouse/Redis, and you're ready to go.
+
+- Self‑hosting guide: https://docs.swetrix.com/selfhosting/how-to
+
+Cloud vs Community Edition
+
+| | Swetrix Cloud | Swetrix Community Edition |
+| ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Infrastructure management | ✅ It's easy to get started with Swetrix Cloud - you can set up tracking in a matter of minutes. We manage server maintenance, upgrades, security for you. | ⚠️ You are responsible for managing servers, installs, upgrades, scaling and backups. |
+| Core analytics (traffic, events, sessions, funnels, performance, errors) | ✅ Included | ✅ Included |
+| Teams & sharing | ✅ Organisations to manage multiple projects and users with permissions setup; invite people to your projects directly, or share a public or password protected link with people. | ⚠️ Only direct project invites, password protected links and public projects are supported. |
+| Alerts & notifications | ✅ Yes (Slack/Telegram/Discord) | ⚠️ Not included |
+| Email reports | ✅ Yes (weekly/monthly/quarterly) | ⚠️ Not included |
+| Geo analytics | ✅ Swetrix Cloud uses premium GeoIP database to provide consistent and accurate country and city level geolocation data. | ⚠️ Less accurate, DB-IP City Lite Database; you need to pay for the full database if you want better accuracy. |
+| Release schedule | ✅ Continuously developed with updates deployed as soon as they are ready | ℹ️ Periodic open‑source releases, latest features are not available immediately. |
+| Support | ✅ Premium support from the people who build and maintain Swetrix | ⚠️ Official support is not included. Community‑driven support on Discord or other forums only. |
+| Costs | ✅ We're an independent and bootstrapped business, your money directly supports Swetrix development. | ⚠️ You pay for the server costs and maintenance, backups, domains and other selfhosting costs, with money going to 3rd party services with no connection to us. |
## Tech Stack
@@ -62,9 +99,14 @@ The [browser tracking script](https://github.com/Swetrix/swetrix-js) is built wi
See our [contributing guide](./CONTRIBUTING.MD) to get started. We welcome any contribution to the project!
+Feel free to go through our [open issues](https://github.com/Swetrix/swetrix/issues) and pick any task you want to work on.
+
### Translations
-TODO
+We welcome translation contributions.
+
+- We manage translations on our [Crowdin](https://crowdin.com/project/swetrix) page.
+- If you'd like to help regularly or add a new language, open an issue and we'll guide you through our translation workflow.
## ⭐️ Star History