Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
laktak committed Aug 21, 2024
1 parent 9494592 commit fb45c82
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


Expand Down Expand Up @@ -50,29 +50,18 @@ 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

```shell
git clone https://github.com/laktak/chkbit
chkbit/scripts/build
# output is here:
chkbit/chkbit
```


## chkbit as a Go module

chkbit is can also be used in other Go programs.

```
go get github.com/laktak/chkbit
# binary:
ls -l chkbit/chkbit
```

For more information see the linked documentation on [pkg.go.dev](https://pkg.go.dev/github.com/laktak/chkbit).


## Usage

Expand Down Expand Up @@ -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?
Expand Down

0 comments on commit fb45c82

Please sign in to comment.