From 72ecb3e609f5142fcdceeaeb2da5223aeec57aa4 Mon Sep 17 00:00:00 2001
From: s3lph <s3lph@kabelsalat.ch>
Date: Sat, 1 Jan 2022 01:28:06 +0100
Subject: [PATCH] Add comments to counterbadge.example.json

---
 counterbadge.example.json | 58 ++++++++++++++++++++-------------------
 1 file changed, 30 insertions(+), 28 deletions(-)

diff --git a/counterbadge.example.json b/counterbadge.example.json
index adf85e0..9eeac01 100644
--- a/counterbadge.example.json
+++ b/counterbadge.example.json
@@ -1,31 +1,33 @@
 {
-	"counters": {
-		"my-treasure-hunt": {
-			"display_name": "My rC3 Treasure Hunt",
-			"unique_tokens": [
-				"bc243542-f7d9-4474-943a-15e5936c9943",
-				"d6cf7658-a556-4784-bcb7-06d12fc47f54",
-				"ee81ad35-2a04-4781-9a09-e925ce2b5eab",
-				"202102f8-aca9-42e1-b6f9-0cb7d0dbb380",
-				"generate unique, non-guessable tokens for each place to visit"
-			],
-			"profile_url": "https://api.rc3.world/api/me",
-			"redeem_url": "https://api.rc3.world/api/c/rc3_21/badges/redeem_token",
-			"api_token": "Your assembly's API token.  Generate it at Maschinenraum / Authentication / Request a New Token",
-			"issue_at": {
-				"1": "A permanent redeem token",
-				"5": "Another permanent redeem token.  Generate it at Maschinenraum / Badges / <the badge> / Create Badge Redeem Token"
-			},
-			"oauth": {
-				"client_id": "Your OAuth2 Client ID.  Register a public OAuth2-Client at Maschinenraum / Authentication / New Application",
-				"client_secret": "Your OAuth2 Client Secret",
-				"authorize_url": "https://rc3.world/sso/authorize/",
-				"token_url": "https://rc3.world/sso/token/",
-				"scope": "rc3_21_attendee",
-				"redirect_url": "https://example.org/counter/my-treasure-hunt/redirect",
-				"response_type": "code"
-			}
-		}
-	}
+    "counters": {
+        "my-treasure-hunt": {  # Give your counter a reasonable slug name.
+            "display_name": "My rC3 Treasure Hunt",  # ... and a reasonable display name.
+            "unique_tokens": [
+                # Generate unique, non-guessable tokens for each place to visit
+                "bc243542-f7d9-4474-943a-15e5936c9943",
+                "d6cf7658-a556-4784-bcb7-06d12fc47f54",
+                "ee81ad35-2a04-4781-9a09-e925ce2b5eab",
+                "202102f8-aca9-42e1-b6f9-0cb7d0dbb380",
+                "05cbbbc0-282e-4ef8-a5af-0be91a914818"
+            ],
+            "profile_url": "https://api.rc3.world/api/me",  # Adapt to your event's profile API URL
+            "redeem_url": "https://api.rc3.world/api/c/rc3_21/badges/redeem_token",  # Adapt to your event's redeem URL
+            "api_token": "Your assembly's API token.  Generate it at Maschinenraum / Authentication / Request a New Token",
+            "issue_at": {
+                # Add badge issue tokens to taste
+                "1": "A permanent redeem token, issued after the first place is found ",
+                "5": "Another permanent redeem token, issued after all five places are found"
+            },
+            "oauth": {  # Adapt to your event's OAuth endpoints
+                "client_id": "Your OAuth2 Client ID.  Register a public OAuth2-Client at Maschinenraum / Authentication / New Application",
+                "client_secret": "Your OAuth2 Client Secret",
+                "authorize_url": "https://rc3.world/sso/authorize/",
+                "token_url": "https://rc3.world/sso/token/",
+                "scope": "rc3_21_attendee",
+                "redirect_url": "https://example.org/counter/my-treasure-hunt/redirect",
+                "response_type": "code"
+            }
+        }
+    }
 }