Upstream/littlelink-server
1
0
Fork 0
mirror of https://github.com/techno-tim/littlelink-server.git synced 2025-01-05 12:27:59 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore(docs): updated readme

Browse Source
This commit is contained in:
Timothy Stewart 2021-10-16 17:03:32 -05:00
parent 8a5e131499
commit e0d659ee25
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -8,7 +8,7 @@ It takes the same simple approach to a link page and hosts it within a NodeJS se
## Supported Links
Check the [config](https://github.com/techno-tim/littlelink-server/blob/master/src/config.js) file for all supported buttons!
## Google Analytics Support
## 📈 Google Analytics Support
See [Getting Started with Analytics](https://support.google.com/analytics/answer/1008015?hl=en). After getting your GA Tracking Id, use your tracking Id as environment variable like `GA_TRACKING_ID=G-XXXXXXXXXX` (See the example below)
@ -20,7 +20,7 @@ Sample event for YouTube button.
window.gtag('event', 'youtube-button');
```
## Umami Analytics Support
## 📈 Umami Analytics Support
See [Adding a website & Collecting data](https://umami.is/docs/collect-data) page to add and generate your tracking code.
@ -38,7 +38,7 @@ Sample event for YouTube button.
window.umami('youtube-button');
```
## Docker
## 🐳 Docker
This container image is published on both [GitHub Container Registry](https://github.com/techno-tim/littlelink-server/pkgs/container/littlelink-server) and [DockerHub](https://hub.docker.com/repository/docker/timothystewart6/littlelink-server) choose whichever one works for you. They will both be updated during CI.
@ -153,7 +153,7 @@ docker run -d \
ghcr.io/techno-tim/littlelink-server:latest
```
## Kubernetes
## ☸ Kubernetes
[Unofficial helm chart provided by k8s-at-home](https://github.com/k8s-at-home/charts/tree/master/charts/stable/littlelink-server)