utm-tracking/README.md

For tracking utm

<!-- 專案名稱 -->

# UTM Tracking

- 要在前往的網址上，增加 UTM 相關訊息
- 需要在沒有 UTM 訊息時，但也能判斷是從什麼搜尋引擎來的時候

這時候，你就需要 `UTM Tracking`

## 安裝 & 文件

#### NPM

```bash
npm install utm-tracking
```

#### YARN

```bash
yarn add utm-tracking
```

你可以將它像這樣的方式引入你的專案

```javascript
import utmTracking from 'utm-tracking'
```

## 該如何使用它？

Step1. 以下 function 需要在程式進入點時呼叫

```javascript
// app.js

// 多久刷新 referrerSessions (單位: 分鐘)
utmTracking.setReferrerSessions(30)
```

Step2. 當按下某個按鈕要跳轉頁面的時候

```javascript
btn.addEventListener('click', () => {
  const link = 'http://www.google.com' // Expected URL
  const combinedLink = utmTracking.mergeUrlParams(link)
  window.location.href = combinedLink
})
```