Skip to content

Commit dcd245b

Browse files
author
tb-peregrine
committed
Update README.md
1 parent 41d0cfb commit dcd245b

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1-
# tinynest
1+
# Tinynest: The Ultimate Dev Stack Analytics Dashboard
2+
Tinynest is an open source utility built with love by Tinybird. Capture and analyze data from over a dozen common dev tools, from Vercel to Stripe to Auth0 and more, with just a few lines of code.
23

3-
Deploy this project to your Tinybird account and configure the webhooks for the services you want to ingest.
4+
## Get Started
5+
To start using Tinynest, you just need to deploy the data project to Tinybird, configure some webhooks, and fork the Next.js app (or use the public app at https://tinynest.tinybird.co with your Tinybird token).
6+
7+
### Deploy the Tinybird data project
8+
You can deploy the entire Tinybird project to your Tinybird account by clicking the button below. If you don't have a Tinybird account you can [signup for free](https://www.tinybird.co/signup).
49

510
<p align="left">
611
<a href="https://app.tinybird.co?starter_kit=https://github.com/tinybirdco/tinynest/tinybird">
712
<img width="200" src="https://img.shields.io/badge/Deploy%20to-Tinybird-25283d?style=flat&labelColor=25283d&color=27f795&logo=data:image/svg+xml;base64,PHN2ZyB2aWV3Qm94PSIwIDAgNTAwIDUwMCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJNNTAwIDQyLjhsLTE1Ni4xLTQyLjgtNTQuOSAxMjIuN3pNMzUwLjcgMzQ1LjRsLTE0Mi45LTUxLjEtODMuOSAyMDUuN3oiIGZpbGw9IiNmZmYiIG9wYWNpdHk9Ii42Ii8+PHBhdGggZD0iTTAgMjE5LjlsMzUwLjcgMTI1LjUgNTcuNS0yNjguMnoiIGZpbGw9IiNmZmYiLz48L3N2Zz4=" />
813
</a>
914
</p>
1015

11-
## Webhooks configuration
16+
### Configure the webhooks
17+
You'll need to configure webhooks from the tools in your stack to send data to Tinybird. Find guides below on how to do that for each tool in the Tinynest.
1218

1319
- [Auth0 Log Streams](https://www.tinybird.co/docs/get-data-in/guides/ingest-auth0-logs)
1420
- [Clerk](https://www.tinybird.co/docs/get-data-in/guides/ingest-from-clerk)

0 commit comments

Comments
 (0)