From 40c2919f37624f208d7f6edd9cd50d4003525525 Mon Sep 17 00:00:00 2001 From: "O.Whale" Date: Thu, 9 May 2024 14:41:50 +0100 Subject: [PATCH] update readme with new cf dash info --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2d5c340..7915da2 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ # WorkerDownloadRecorder ## A simple cloudflare worker, that records download numbers & page views. ### Install: -- Clone repo -- Install dependencies -- Run `wrangler deploy` -- Attach a two KVs to this worker, `WDR` & `WVR` for download records & page views respectively. +- Download the worker.js +- Create a [new worker.](https://developers.cloudflare.com/workers/get-started/guide/#get-started-in-the-dashboard) +- Select "Edit in browser" or "edit". +- Paste the code from worker.js into the edit box, and deploy +- Attach a two KVs to this worker, `WDR` & `WVR` for download records & page views respectively. (These can be found under the variables tab) +- Add a variable named `url` with a discord webhook. ### Usage (Downloads): - - Change your download links to `https://Your.Worker.workers.dev/reder?url=`GH_Username/Repo?file=Release_Number/File_Name.ext
+ - Change your download links to `https://Your.Worker.workers.dev/reder?url=GH_Username/Repo?file=Release_Number/File_Name.ext`
- Change GH_Username, Repo, Release_Number & File_Name.ext
- E.G: download.niceygy.worker.dev/reder?url=niceygylive/niceygylive.xyz?file=1.2.1/setup.exe - - It will record the download, then redirect the user to github.com/GH_Username/Repo/releases/Release_Number/File_Name.ext + (E.G: `download.niceygy.worker.dev/reder?url=niceygylive/niceygylive.xyz?file=1.2.1/setup.exe`) + - It will record the download, then redirect the user to `github.com/GH_Username/Repo/releases/Release_Number/File_Name.ext` ### Usage (Page Views): - Add `` to any of your pages. This will send a single request to the worker on page load, which then records it. @@ -19,4 +21,4 @@ E.G: `https://Your.Worker.workers.dev?page=/downloads/download-recorder` ### Usage (Discord webhook): - Add a env variable `url` with your discord webhook url. -- Add a cron trigger to the worker, to send the stats to the webhook. \ No newline at end of file +- Add a cron trigger to the worker, to send the stats to the webhook.