From fb45c826258cac92e17c7a758657f4eafe67e728 Mon Sep 17 00:00:00 2001 From: Christian Zangl Date: Wed, 21 Aug 2024 20:30:07 +0200 Subject: [PATCH] readme --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 1573efc..d9ac8ce 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ chkbit is a tool that ensures the safety of your files by checking if their *dat - [How it works](#how-it-works) - [Installation](#installation) -- [chkbit as a Go module](#chkbit-as-a-go-module) - [Usage](#usage) - [Repair](#repair) - [Ignore files](#ignore-files) +- [chkbit as a Go module](#chkbit-as-a-go-module) - [FAQ](#faq) @@ -50,7 +50,7 @@ Building from the source requires Go. - Either install it directly ```shell -go install github.com/laktak/chkbit@latest +go install github.com/laktak/chkbit/v5/cmd/chkbit@latest ``` - or clone and build @@ -58,22 +58,11 @@ go install github.com/laktak/chkbit@latest ```shell git clone https://github.com/laktak/chkbit chkbit/scripts/build -# output is here: -chkbit/chkbit +# binary: +ls -l chkbit/chkbit ``` -## chkbit as a Go module - -chkbit is can also be used in other Go programs. - -``` -go get github.com/laktak/chkbit -``` - -For more information see the linked documentation on [pkg.go.dev](https://pkg.go.dev/github.com/laktak/chkbit). - - ## Usage Run `chkbit -u PATH` to create/update the chkbit index. @@ -163,6 +152,17 @@ Add a `.chkbitignore` file containing the names of the files/directories you wis - hidden files (starting with a `.`) are ignored by default +## chkbit as a Go module + +chkbit is can also be used in other Go programs. + +``` +go get github.com/laktak/chkbit/v5 +``` + +For more information see the documentation on [pkg.go.dev](https://pkg.go.dev/github.com/laktak/chkbit/v5). + + ## FAQ ### Should I run `chkbit` on my whole drive?