From 5af3d57abb020851f6d839d5eb0398ac5d47f17c Mon Sep 17 00:00:00 2001
From: Albert Y <76888457+filterpaper@users.noreply.github.com>
Date: Thu, 13 Jan 2022 10:01:13 +0800
Subject: [PATCH] Add a note for GitHub SSH scheme

---
 docs/docs/user-setup.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/docs/user-setup.md b/docs/docs/user-setup.md
index 6c80f882..1869e542 100644
--- a/docs/docs/user-setup.md
+++ b/docs/docs/user-setup.md
@@ -156,6 +156,10 @@ Preparing a user config for:
 Continue? [Yn]:
 ```
 
+:::note
+If you are using SSH keys for GitHub push, change the repository field to the SSH scheme, e.g. `git@github.com:petejohanson/zmk-config.git'.
+:::
+
 After hitting `Enter` or typing `y`, the script will create an initial config in a directory named after the repo name,
 update the GitHub Action YAML file, commit the initial version, and then push to your repo.