Skip to content

Commit

Permalink
update template
Browse files Browse the repository at this point in the history
  • Loading branch information
alrocar committed Dec 24, 2024
1 parent e9a5a8b commit 475e9ea
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Build your own web analytics platform using [Tinybird](https://www.tinybird.co/)'s Events API and Endpoints.

Built with privacy and speed as top priorities, this Starter Kit lets you get real-time metrics in a pre-built dashboard in just a few minutes without any knowledge about Tinybird and extend it with custom events tailored to your specific use cases (eCommerce, marketing, etc.).
Built with privacy and speed as top priorities, this template lets you get real-time metrics in a pre-built dashboard in just a few minutes without any knowledge about Tinybird and extend it with custom events tailored to your specific use cases (eCommerce, marketing, etc.).

## 1. Set up the project

Expand All @@ -20,20 +20,12 @@ Copy the snippet and paste it on your site `<head>`
></script>
```

Script parameters:

| Parameter | Mandatory | Description |
| ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data-token` | Yes | Your `tracker` [token](https://app.tinybird.co/tokens). It's already created for you, you can find it on the Tinybird UI under "Manage Auth Tokens" |
| `data-proxy` | No | Your domain URL to proxy the request, if you follow the optional steps for "GDPR Best Practices" |
| `data-host` | No | Tinybird host URL. Ddefaults to `https://api.tinybird.co/`, but could be `https://api.us-east.tinybird.co` or a dedicated cluster. The banner already generates the snippet with the proper host. |
| `data-datasource` | No | If you iterate the landing data source, or you just want to ingest the event in a different one, you can specify the landing data source name. |
Use the `data-host` attribute to set your Tinybird host URL. Defaults to `https://api.tinybird.co/`.

## 3. Learn more

To learn more about the Web Analytics Starter Kit, local development and more, check out the [README](https://github.com/tinybirdco/web-analytics-starter-kit/blob/main/README.md).
To learn more about the Web Analytics template, how to customize your events, GDPR and more, check out the [README](https://github.com/tinybirdco/web-analytics-starter-kit/blob/main/README.md).

## 4. Support

If you have any questions or need help, please reach out to us on [Slack](https://www.tinybird.co/join-our-slack-community) or [email](mailto:[email protected]).

0 comments on commit 475e9ea

Please sign in to comment.