Skip to content

Commit

Permalink
Updated help info
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Gardner committed May 6, 2019
1 parent e7959e9 commit 5f54d3c
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 7 deletions.
8 changes: 2 additions & 6 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -207,13 +207,9 @@ _list-dir path='.':
fi

# Run Helper
@run id='app' +args='':
just _term-lw "{{PROJECT_NAME}}"
just --highlight run-{{id}} {{args}}

# Run the app
@run-app +args='':
@run +args='':
just _term-lw "{{PROJECT_NAME}}"
echo "$ {{BINARY_NAME}} {{args}}"
go run {{SOURCE_NAME}} {{args}}

Expand Down
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FileDelta v0.3.0
FileDelta v0.4.0
================

1. Calculates the SHA-256 hash of a file
Expand All @@ -21,6 +21,28 @@ test/touched.txt: ERROR
Exit Code: 1
```

Help Example
------------

```bash
$ filedelta --help
FileDelta v0.4.0

File change detection tool

USAGE: filedelta [OPTIONS] COMMAND FILENAME

COMMANDS
check Compares the provided files hash against the one stored
store Stores the provided files hash for later comparison

OPTIONS
-d | --debug Output debugging info
-h | --help Output this help info
-v | --version Output app version info

```

Hashes are now stored in `$HOME/.local/filedelta/cache/` in plain text files.

This was inspired by a short discussion at <https://github.com/casey/just/issues/424>
Expand Down
2 changes: 2 additions & 0 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ var (
AppLabel = AppMetaData(fmt.Sprintf("%s v%s", string(AppName), string(AppVersion)))
AppHelp = AppMetaData(fmt.Sprintf("%s\n\n%s", string(AppLabel), string(AppDesc)) + `
USAGE: filedelta [OPTIONS] COMMAND FILENAME
COMMANDS
check Compares the provided files hash against the one stored
store Stores the provided files hash for later comparison
Expand Down

0 comments on commit 5f54d3c

Please # to comment.