Skip to content

Commit

Permalink
Update TEMPLATE.md (#112)
Browse files Browse the repository at this point in the history
  • Loading branch information
theletterf authored Dec 30, 2024
1 parent 4a5c33b commit 1c5ced8
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Build your own web analytics platform using [Tinybird](https://www.tinybird.co/)'s Events API and Endpoints.
The Web Analytics template help you set up 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 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
## Set up the project

Fork the GitHub repository and deploy the data project to Tinybird.

[Deploy the dashboard](https://github.com/tinybirdco/web-analytics-starter-kit/blob/main/dashboard/README.md) to Vercel or use the hosted dashboard at https://analytics.tinybird.co/ using the Workspace `dashboard` [token](https://app.tinybird.co/tokens).

## 2. Send events from your site
## Send events from your site

Copy the snippet and paste it on your site `<head>`
Copy the snippet and paste it within your site `<head>` section:

```html
<script
Expand All @@ -21,11 +21,3 @@ Copy the snippet and paste it on your site `<head>`
```

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 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 1c5ced8

Please sign in to comment.