update readme [CI SKIP]

.github/workflows/release.yml

@@ -2,8 +2,9 @@ name: goreleaser
 
 on:
   push:
-    branches: [ master ] # your default branch if different
-    paths: [ CHANGELOG.md ] # your changelog file if different
+    # run only against tags
+    tags:
+      - '*'
 
 permissions:
   contents: write
@@ -24,12 +25,17 @@ jobs:
           cache: true
       # More assembly might be required: Docker logins, GPG, etc. It all depends
       # on your needs.
+      - name: Get tag
+        id: tag
+        uses: dawidd6/action-get-tag@v1
+        with:
+          # Optionally strip `v` prefix
+          strip_v: true
       - uses: goreleaser/goreleaser-action@v4
         with:
-          # either 'goreleaser' (default) or 'goreleaser-pro':
           distribution: goreleaser
           version: latest
-          args: release --release-notes=".changes/$(go run backy.go version).md" -f .goreleaser/github.yml --clean
+          args: release --release-notes=".changes/${{steps.tag.outputs.tag}}.md" -f .goreleaser/github.yml --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GORELEASER_TOKEN }}
           # Your GoReleaser Pro key, if you are using the 'goreleaser-pro'

README.md

@@ -1,16 +1,11 @@
+
 # Backy - an application to manage backups
 
-This app is in development, and is currently not stable. Expect core functionality to possiblly break.
+See the [install documentation](https://backy.cybershell.xyz/getting-started/install/index.html)
 
-## Installing
+## Security
 
-To install:
-
-`go install git.andrewnw.xyz/CyberShell/backy@master`
-
-This assumes you already have a working Go environment, if not please see [this page](https://golang.org/doc/install) first.
-
-You can also download binaries [here](https://git.andrewnw.xyz/CyberShell/backy/releases) and [here](https://github.com/CybersShell/backy/releases).
+The latest version is currently the only supported version.
 
 ## Features
 
@@ -25,21 +20,3 @@ You can also download binaries [here](https://git.andrewnw.xyz/CyberShell/backy/
 - Run in cron mode
 
 - For any command, especially backup commands
-
-To run a config:
-
-`backy backup`
-
-Or to use a specific file:
-```backy backup -f /path/to/file```
-
-If you leave the config path blank, the following paths will be searched in order:
-
-- `./backy.yml`
-- `./backy.yaml`
-- `~/.config/backy.yml`
-- `~/.config/backy.yaml`
-
-Create a file at `~/.config/backy.yml`.
-
-See the config file in the examples directory to configure it.