Skip to content

Commit 66e62be

Browse files
committed
docs: updates README docs for installation of latest build
1 parent de95ec6 commit 66e62be

File tree

2 files changed

+34
-10
lines changed

2 files changed

+34
-10
lines changed

README.md

+31-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,29 @@
1-
### fwatcher
1+
## fwatcher
22

3-
fwatcher is a simple golang CLI tool to monitor file changes and run some commands on them.
4-
It is intended to work like `nodemon`.
3+
fwatcher is a simple golang CLI tool to monitor file changes and run some commands on those events.
4+
5+
### Installation
6+
7+
#### linux x86_64 (amd64)
8+
```console
9+
curl -L0 https://github.com/nxtcoder17/fwatcher/releases/latest/download/fwatcher-linux-amd64 > ./fwatcher
10+
```
11+
#### linux arm64 (aarch64)
12+
```console
13+
curl -L0 https://github.com/nxtcoder17/fwatcher/releases/latest/download/fwatcher-linux-arm64 > ./fwatcher
14+
```
15+
16+
#### macos amd64 (amd64)
17+
```console
18+
curl -L0 https://github.com/nxtcoder17/fwatcher/releases/latest/download/fwatcher-darwin-amd64 > ./fwatcher
19+
```
20+
21+
#### macos arm64 (aarch64)
22+
```console
23+
curl -L0 https://github.com/nxtcoder17/fwatcher/releases/latest/download/fwatcher-darwin-arm64 > ./fwatcher
24+
```
25+
26+
### Usage
527

628
```console
729
NAME:
@@ -15,12 +37,13 @@ COMMANDS:
1537

1638
GLOBAL OPTIONS:
1739
--debug toggles showing debug logs (default: false)
18-
--exec value specifies command to execute on file change
19-
--dir value, -d value directory to watch on (default: "$PWD")
20-
--extensions value, --ext value [ --extensions value, --ext value ] file extensions to watch on
21-
--ignore-extensions value, --iext value [ --ignore-extensions value, --iext value ] file extensions to ignore watching on
22-
--exclude-dir value, --exclude value [ --exclude-dir value, --exclude value ] directory to exclude from watching
40+
--command value, -c value specifies command to execute on file change
41+
--dir value, -d value directory to watch on (default: ".")
42+
--ignore-suffixes value, -i value [ --ignore-suffixes value, -i value ] files suffixes to ignore
43+
--exclude-dir value, -x value, -e value [ --exclude-dir value, -x value, -e value ] directory to exclude from watching
44+
--no-default-ignore, -I disables ignoring from default ignore list (default: false)
2345
--help, -h show help
46+
--version, -v print the version
2447
```
2548

2649
[See fwatcher in action](https://github.com/nxtcoder17/fwatcher/assets/22402557/ce1b1908-cb9f-438f-85c1-3a8858265c40)

Taskfile.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ tasks:
3737
{{.Bin}} --debug --ext '.go' --exec 'go run ./examples/http-server/main.go'
3838
3939
install:
40-
vars:
4140
cmds:
4241
- task: build
43-
- ln -sf $PWD/{{.Bin}} $HOME/.local/bin/{{.Name}}
42+
vars:
43+
version: dev
44+
- ln -sf $PWD/bin/{{.name}} $HOME/.local/bin/{{.name}}

0 commit comments

Comments
 (0)