Skip to content

Commit 95a7907

Browse files
committed
Add link to readme
1 parent a70cdf5 commit 95a7907

File tree

2 files changed

+18
-15
lines changed

2 files changed

+18
-15
lines changed

README.Rmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,18 @@ knitr::opts_chunk$set(
2424

2525
Watch the File System for Changes
2626

27-
R binding for 'libfswatch', a file system monitoring library. This uses an optimal event-driven API for each platform:
27+
R binding for [libfswatch](https://emcrisostomo.github.io/fswatch/), a file system monitoring library. This uses an optimal event-driven API for each platform:
2828

2929
- `ReadDirectoryChangesW` on Windows
3030
- `FSEvents` on MacOS
3131
- `inotify` on Linux
3232
- `kqueue` on BSD
3333
- `File Events Notification` on Solaris/Illumos
3434

35-
Watching is done asynchronously in the background, without blocking the session.
35+
Watching is performed asynchronously in the background, without blocking the session.
3636

3737
- Watch files, or directories recursively.
38-
- Log activity, or run an R function every time a change event occurs.
38+
- Log activity, or call an R function, upon every change event.
3939

4040
## Installation
4141

@@ -92,7 +92,7 @@ unlink(dir, recursive = TRUE, force = TRUE)
9292

9393
## Acknowledgements
9494

95-
Thanks to the authors of 'libfswatch', upon which this package is based:
95+
Thanks to the authors of [libfswatch](https://emcrisostomo.github.io/fswatch/), upon which this package is based:
9696

9797
- Alan Dipert
9898
- Enrico M. Crisostomo

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,21 @@ coverage](https://codecov.io/gh/r-lib/watcher/graph/badge.svg)](https://app.code
1414

1515
Watch the File System for Changes
1616

17-
R binding for ‘libfswatch’, a file system monitoring library. This uses
18-
an optimal event-driven API for each platform:
17+
R binding for [libfswatch](https://emcrisostomo.github.io/fswatch/), a
18+
file system monitoring library. This uses an optimal event-driven API
19+
for each platform:
1920

2021
- `ReadDirectoryChangesW` on Windows
2122
- `FSEvents` on MacOS
2223
- `inotify` on Linux
2324
- `kqueue` on BSD
2425
- `File Events Notification` on Solaris/Illumos
2526

26-
Watching is done asynchronously in the background, without blocking the
27-
session.
27+
Watching is performed asynchronously in the background, without blocking
28+
the session.
2829

2930
- Watch files, or directories recursively.
30-
- Log activity, or run an R function every time a change event occurs.
31+
- Log activity, or call an R function, upon every change event.
3132

3233
## Installation
3334

@@ -78,7 +79,7 @@ w
7879
#> start: function ()
7980
#> stop: function ()
8081
#> Private:
81-
#> path: /tmp/RtmpLJO67C/watcher-example
82+
#> path: /tmp/RtmpslHgGB/watcher-example
8283
#> running: FALSE
8384
#> watch: externalptr
8485
w$start()
@@ -88,27 +89,29 @@ file.create(file.path(dir, "newfile"))
8889
file.create(file.path(dir, "anotherfile"))
8990
#> [1] TRUE
9091
later::run_now(1)
91-
#> [1] "/tmp/RtmpLJO67C/watcher-example/newfile"
92-
#> [1] "/tmp/RtmpLJO67C/watcher-example/anotherfile"
92+
#> [1] "/tmp/RtmpslHgGB/watcher-example/newfile"
93+
#> [1] "/tmp/RtmpslHgGB/watcher-example/anotherfile"
9394

9495
newfile <- file(file.path(dir, "newfile"), open = "r+")
9596
cat("hello", file = newfile)
9697
close(newfile)
9798
later::run_now(1)
98-
#> [1] "/tmp/RtmpLJO67C/watcher-example/newfile"
99+
#> [1] "/tmp/RtmpslHgGB/watcher-example/newfile"
99100

100101
file.remove(file.path(dir, "newfile"))
101102
#> [1] TRUE
102103
later::run_now(1)
103-
#> [1] "/tmp/RtmpLJO67C/watcher-example/newfile"
104+
#> [1] "/tmp/RtmpslHgGB/watcher-example/newfile"
104105

105106
w$stop()
106107
unlink(dir, recursive = TRUE, force = TRUE)
107108
```
108109

109110
## Acknowledgements
110111

111-
Thanks to the authors of ‘libfswatch’, upon which this package is based:
112+
Thanks to the authors of
113+
[libfswatch](https://emcrisostomo.github.io/fswatch/), upon which this
114+
package is based:
112115

113116
- Alan Dipert
114117
- Enrico M. Crisostomo

0 commit comments

Comments
 (0)