From 21dfe24bca2e8c8b359fc1027a6ca15e3a499a80 Mon Sep 17 00:00:00 2001
From: Brendan Golden <git@brendan.ie>
Date: Sun, 22 Sep 2024 23:12:24 +0100
Subject: [PATCH] doc: added readme and rough overview

---
 README.md             | 26 ++++++++++++++++++++++++++
 resources/Secrets.png |  3 +++
 2 files changed, 29 insertions(+)
 create mode 100644 README.md
 create mode 100644 resources/Secrets.png

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5873eba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Deploying to Skynet
+This is a repo that is used as a template to deploy to Skynet
+
+
+## Create SSH Key
+Details to do this can be found here: [wiki](https://wiki.skynet.ie/tutorials/skynet/create_ssh/)  
+It is recommended to create a new key for just Forgejo Actions.
+
+## Secrets
+Two secrets must be added to make this work.
+
+Secrets are found in your repo under ``Settings > Actions > Secrets``
+
+* USERNAME
+  * This is your skynet username
+* SSH_KEY
+  * This is your private key that was generated above
+
+End result should look like this:  
+![Secrets](resources/Secrets.png)  
+
+
+## Make changes to ``src``
+Make changes to the files in ``src``.  
+Commit and push.  
+If everything was set up fine then your site will soon be live on ``https://$USERNAME.users.skynet.ie``
\ No newline at end of file
diff --git a/resources/Secrets.png b/resources/Secrets.png
new file mode 100644
index 0000000..d555fb2
--- /dev/null
+++ b/resources/Secrets.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bedff41d5e804577020539b26da95c2034b5f768b08590611975c9f2a6795faf
+size 42331