Skip to content

Commit

Permalink
docs: updates README docs for installation of latest build
Browse files Browse the repository at this point in the history
  • Loading branch information
nxtcoder17 committed Sep 23, 2024
1 parent de95ec6 commit 66e62be
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 10 deletions.
39 changes: 31 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
### fwatcher
## fwatcher

fwatcher is a simple golang CLI tool to monitor file changes and run some commands on them.
It is intended to work like `nodemon`.
fwatcher is a simple golang CLI tool to monitor file changes and run some commands on those events.

### Installation

#### linux x86_64 (amd64)
```console
curl -L0 https://github.com/nxtcoder17/fwatcher/releases/latest/download/fwatcher-linux-amd64 > ./fwatcher
```
#### linux arm64 (aarch64)
```console
curl -L0 https://github.com/nxtcoder17/fwatcher/releases/latest/download/fwatcher-linux-arm64 > ./fwatcher
```

#### macos amd64 (amd64)
```console
curl -L0 https://github.com/nxtcoder17/fwatcher/releases/latest/download/fwatcher-darwin-amd64 > ./fwatcher
```

#### macos arm64 (aarch64)
```console
curl -L0 https://github.com/nxtcoder17/fwatcher/releases/latest/download/fwatcher-darwin-arm64 > ./fwatcher
```

### Usage

```console
NAME:
Expand All @@ -15,12 +37,13 @@ COMMANDS:

GLOBAL OPTIONS:
--debug toggles showing debug logs (default: false)
--exec value specifies command to execute on file change
--dir value, -d value directory to watch on (default: "$PWD")
--extensions value, --ext value [ --extensions value, --ext value ] file extensions to watch on
--ignore-extensions value, --iext value [ --ignore-extensions value, --iext value ] file extensions to ignore watching on
--exclude-dir value, --exclude value [ --exclude-dir value, --exclude value ] directory to exclude from watching
--command value, -c value specifies command to execute on file change
--dir value, -d value directory to watch on (default: ".")
--ignore-suffixes value, -i value [ --ignore-suffixes value, -i value ] files suffixes to ignore
--exclude-dir value, -x value, -e value [ --exclude-dir value, -x value, -e value ] directory to exclude from watching
--no-default-ignore, -I disables ignoring from default ignore list (default: false)
--help, -h show help
--version, -v print the version
```

[See fwatcher in action](https://github.com/nxtcoder17/fwatcher/assets/22402557/ce1b1908-cb9f-438f-85c1-3a8858265c40)
Expand Down
5 changes: 3 additions & 2 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ tasks:
{{.Bin}} --debug --ext '.go' --exec 'go run ./examples/http-server/main.go'
install:
vars:
cmds:
- task: build
- ln -sf $PWD/{{.Bin}} $HOME/.local/bin/{{.Name}}
vars:
version: dev
- ln -sf $PWD/bin/{{.name}} $HOME/.local/bin/{{.name}}

0 comments on commit 66e62be

Please sign in to comment.