update site

Author: j-keck

README.org

@@ -23,7 +23,7 @@ See the [[https://j-keck.github.io/zfs-snap-diff/][website]] for more details.
 
  The minimum supported go version is =go1.12=.
 
-   - clone this repo: ~git clone https://github.com/j-keck/zfs-snap-diff~
+   - clone this repo: ~git clone --depth 1 https://github.com/j-keck/zfs-snap-diff~
    - ~cd zfs-snap-diff~
    - build it: ~go build -ldflags="-X main.version=$(git describe)" ./cmd/zfs-snap-diff~
 
@@ -35,7 +35,7 @@ See the [[https://j-keck.github.io/zfs-snap-diff/][website]] for more details.
 I use [[https://nixos.org/nix/][nix]] to build my projects. The ~nix~ build also compiles the frontend
 to javascript and decode it in ~pkg/webapp/bindata.go~.
 
-   - clone this repo: ~git clone https://github.com/j-keck/zfs-snap-diff~
+   - clone this repo: ~git clone --depth 1 https://github.com/j-keck/zfs-snap-diff~
    - ~cd zfs-snap-diff~
    - build it: ~nix-build -A zfs-snap-diff~
 

doc/site/content/docs/install.md

@@ -23,27 +23,35 @@ You can download the latest binary package from here or from the [GitHub release
 
 {{<tabs "install">}}
 {{< tab "Linux" >}}
-Download the beta version for ****Linux amd64**** here:
+  1.) ****Download**** the latest version for ****Linux amd64****: [zfs-snap-diff-linux-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-linux-v1.0.0.tgz)
 
-[zfs-snap-diff-linux-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-linux-v1.0.0.tgz)
+2.) Unpack the archive: `tar xvf zfs-snap-diff-linux-v1.0.0.tgz`
+
+  3.) Run it:  `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
 {{< /tab >}}
 
 {{< tab "FreeBSD" >}}
-Download the beta version for ****FreeBSD amd64**** here:
+  1.) ****Download**** the latest version for ****FreeBSD amd64****: [zfs-snap-diff-freebsd-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-freebsd-v1.0.0.tgz)
+
+2.) Unpack the archive: `tar xvf zfs-snap-diff-freebsd-v1.0.0.tgz`
 
-[zfs-snap-diff-freebsd-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-freebsd-v1.0.0.tgz)
+  3.) Run it:  `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
 {{< /tab >}}
 
 {{< tab "macOS" >}}
-Download the beta version for ****macOS amd64**** here:
+  1.) ****Download**** the latest version for ****macOS amd64****: [zfs-snap-diff-darwin-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-darwin-v1.0.0.tgz)
 
-[zfs-snap-diff-darwin-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-darwin-v1.0.0.tgz)
+2.) Unpack the archive: `tar xvf zfs-snap-diff-darwin-v1.0.0.tgz`
+
+  3.) Run it:  `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
 {{< /tab >}}
 
 {{< tab "Solaris" >}}
-Download the beta version for ****Solaris amd64**** here:
+  1.) ****Download**** the latest version for ****Solaris amd64****: [zfs-snap-diff-solaris-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-solaris-v1.0.0.tgz)
+
+2.) Unpack the archive: `tar xvf zfs-snap-diff-solaris-v1.0.0.tgz`
 
-[zfs-snap-diff-solaris-v1.0.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.0/zfs-snap-diff-solaris-v1.0.0.tgz)
+  3.) Run it:  `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
 {{< /tab >}}
 
 {{< /tabs >}}
@@ -70,7 +78,7 @@ go source file so you need only the go compiler to compile it yourself.
 
 The minimum supported go version is `go1.12`.
 
--   clone this repo: `git clone https://github.com/j-keck/zfs-snap-diff`
+-   clone this repo: `git clone --depth 1 https://github.com/j-keck/zfs-snap-diff`
 -   `cd zfs-snap-diff`
 -   build it: `go build -ldflags="-X main.version=$(git describe)" ./cmd/zfs-snap-diff`
 
@@ -82,7 +90,7 @@ The optional `-ldflags="-X main.version=$(git describe)"` flag updates the `vers
 I use [nix](https://nixos.org/nix/) to build my projects. The `nix` build also compiles the frontend
 to javascript and decode it in `pkg/webapp/bindata.go`.
 
--   clone this repo: `git clone -b dev https://github.com/j-keck/zfs-snap-diff`
+-   clone this repo: `git clone --depth 1 https://github.com/j-keck/zfs-snap-diff`
 -   change to the checkout directory: `cd zfs-snap-diff`
 -   build it: `nix-build -A zfs-snap-diff`
 

site.org

@@ -82,10 +82,12 @@ You can download the latest binary package from here or from the [[https://githu
 
      (defun section-for (platform artifact version)
        (format (concat "{{< tab \"%s\" >}}\n"
-                       "Download the beta version for **%s amd64** here:\n\n"
-                       "[[https://github.com/j-keck/zfs-snap-diff/releases/download/%s/%s][%s]]\n"
+                       "  1.) **Download** the latest version for **%s amd64**: "
+                       "[[https://github.com/j-keck/zfs-snap-diff/releases/download/%s/%s][%s]]\n\n"
+                       "  2.) Unpack the archive: ~tar xvf %s~\n\n"
+                       "  3.) Run it:  ~./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>~\n"
                        "{{< /tab >}}\n\n"
-               ) platform platform version artifact artifact))
+               ) platform platform version artifact artifact artifact))
 
      (let ((v (version-string)))
        (princ "\n\n{{<tabs \"install\">}}\n")
@@ -96,9 +98,6 @@ You can download the latest binary package from here or from the [[https://githu
        (princ "{{< /tabs >}}\n\n"))
  #+END_SRC
 
- #+RESULTS:
-
-
 
 {{< hint warning >}}
 Try with the ~-use-sudo~ flag if it's not working - and please give feedback.
@@ -122,7 +121,7 @@ platform, feel free to contact me!
 
 The minimum supported go version is =go1.12=.
 
-  - clone this repo: ~git clone https://github.com/j-keck/zfs-snap-diff~
+  - clone this repo: ~git clone --depth 1 https://github.com/j-keck/zfs-snap-diff~
   - ~cd zfs-snap-diff~
   - build it: ~go build -ldflags="-X main.version=$(git describe)" ./cmd/zfs-snap-diff~
 
@@ -134,7 +133,7 @@ The optional ~-ldflags="-X main.version=$(git describe)"~ flag updates the ~vers
 I use [[https://nixos.org/nix/][nix]] to build my projects. The ~nix~ build also compiles the frontend
 to javascript and decode it in ~pkg/webapp/bindata.go~.
 
-  - clone this repo: ~git clone -b dev https://github.com/j-keck/zfs-snap-diff~
+  - clone this repo: ~git clone --depth 1 https://github.com/j-keck/zfs-snap-diff~
   - change to the checkout directory: ~cd zfs-snap-diff~
   - build it: ~nix-build -A zfs-snap-diff~