(added) installation instructions

dev-steinbrecher · Aug 5, 2024 · 54f793d · 54f793d
1 parent 4dd3626
commit 54f793d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/.github/workflows/releases.yml b/.github/workflows/releases.yml
@@ -26,11 +26,13 @@ jobs:
       - name: Create ZIP file
         run: |
           mkdir release
-          zip -r release/cloudflare-dynamic-dns@${{ env.VERSION }}.zip src/*
+          cd src
+          zip -r ../release/cloudflare-dynamic-dns.zip .
+          cd ..
 
       - name: Create GitHub Release and Upload Asset
         id: create_release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          gh release create ${{ env.VERSION }} ./release/cloudflare-dynamic-dns@${{ env.VERSION }}.zip --title "Release ${{ env.VERSION }}" --notes "Automated release for version ${{ env.VERSION }}" --repo ${{ github.repository }}
+          gh release create ${{ env.VERSION }} ./release/cloudflare-dynamic-dns.zip --title "Release ${{ env.VERSION }}" --notes "Automated release for version ${{ env.VERSION }}" --repo ${{ github.repository }}
diff --git a/README.md b/README.md
@@ -4,6 +4,18 @@ This is a small script to change you IP dynamically in Cloudflare in case your i
 
 It supports IPv4 and IPv6
 
+## How to use
+
+### Run commands
+
+```bash
+ mkdir "cloudflare-dynamic-dns"
+ cd "cloudflare-dynamic-dns"
+ wget https://github.com/dev-steinbrecher/cloudflare-dynamic-dns/releases/latest/download/cloudflare-dynamic-dns.zip
+ unzip cloudflare-dynamic-dns.zip
+ rm cloudflare-dynamic-dns.zip
+```
+
 ### Create an API token for the Cloudflare API
 
 [Create Token](https://dash.cloudflare.com/profile/api-tokens)