Skip to content

Commit

Permalink
adapt README
Browse files Browse the repository at this point in the history
adapt README
  • Loading branch information
St3ffn committed May 27, 2021
1 parent 7561201 commit eb71018
Showing 1 changed file with 34 additions and 3 deletions.
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

![count](https://media.giphy.com/media/3owzW5c1tPq63MPmWk/giphy.gif)

Tiny CLI tool to find out how many chia plots will still fit on your hard disk. In other word to say:
How many chia plots do I have left on my hard disk. The tool will work fine on all unix systems (unix, linux, macos)
Tiny CLI tool to find out how many chia plots will still fit on your hard disk. In other words to say:
How many chia plots do I have left on my hard disk. The tool will work fine on all unix based systems (unix, linux, macos)

## Getting started

Expand Down Expand Up @@ -37,7 +37,38 @@ Now you are ready to go.

### Usage

...
```bash
# find out how many chia plots will still fit on /path/to/plots
> plots-left /path/to/plots
```

To specify the amount of plots to reserve use `--reserve` or `-r`
```bash
# find out how many chia plots will still fit on /path/to/plots
# reserve 1 chia plot
> plots-left -r 1 /path/to/plots
```
Call with `--help` or `-h` to see the help page
```bash
> plots-left -h

NAME:
plots-left - find out how many plots will still fit on your hard disk

USAGE:
plots-left [-r RESERVE] PATH
plots-left -r 1 /plots/nas1

DESCRIPTION:
Tool will perform the following calculation (AVAILABLE_DISK_SPACE/SINGLE_PLOT_SIZE)-RESERVED_PLOTS.

GLOBAL OPTIONS:
--reserve RESERVE, -r RESERVE RESERVE. the amount of plots to reserve. (default: 0)
--help, -h show help (default: false)

COPYRIGHT:
GNU GPLv3
```

## Kind gestures

Expand Down

0 comments on commit eb71018

Please sign in to comment.