diff --git a/README.md b/README.md
index 19eee1b..ea6ea87 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,35 @@
 # actions-deploy-to-skynet
 
+## v2
+### deploy
+```yaml
+jobs:
+  # deploy it upstream
+  deploy:
+    # runs on teh default docker container
+    runs-on: docker
+    needs: [ build ]
+    steps:
+      - name: "Deploy to Skynet"
+        uses: https://forgejo.skynet.ie/Skynet/actions-deploy-to-skynet@v2
+        with:
+          input: 'compsoc_public'
+          token: ${{ secrets.API_TOKEN_FORGEJO }}
+```
+
+## v3
+### deploy
+```yaml
+jobs:
+  # deploy it upstream
+  deploy:
+    # runs on teh default docker container
+    runs-on: docker
+    needs: [ build ]
+    steps:
+      - name: "Deploy to Skynet"
+        uses: https://forgejo.skynet.ie/Skynet/actions-deploy-to-skynet/deploy@v3
+        with:
+          input: 'compsoc_public'
+          token: ${{ secrets.API_TOKEN_FORGEJO }}
+```
\ No newline at end of file
diff --git a/action.yml b/deploy/action.yml
similarity index 100%
rename from action.yml
rename to deploy/action.yml