Skip to content

Commit 235d47d

Browse files
authored
docs: improve documentation
1 parent e062672 commit 235d47d

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Positionals:
4545
-E, --error throw error if nothing is copied [boolean]
4646
-V, --verbose print more information to console [boolean]
4747
-F, --follow follow symbolic links [boolean]
48-
-s, --stat show statistics after execution (time + file count) [boolean]
48+
-s, --stat show statistics after execution (time + files/folders count) [boolean]
4949
-v, --version show version number [boolean]
5050
-h, --help show help [boolean]
5151
```
@@ -198,7 +198,7 @@ The `rename` callback gives you full control over the output filename and path.
198198
```js
199199
import { copyfiles } from 'native-copyfiles';
200200

201-
copyfiles(paths, target, opt, callback);
201+
copyfiles(sources, destination, opt, callback);
202202
```
203203

204204
1. first argument is a string or an array of source paths
@@ -215,10 +215,10 @@ copyfiles(paths, target, opt, callback);
215215
dryRun: boolean; // show what would be copied, without actually copying anything
216216
follow: boolean; // follow symlinked directories when expanding ** patterns
217217
error: boolean; // raise errors if no files copied
218-
stat: boolean; // show statistics after execution (time + file count)
218+
stat: boolean; // show statistics after execution (time + files or folders count)
219219
rename: (src, dest) => string; // callback to transform the destination filename(s)
220220
}
221221
```
222222

223223
> [!WARNING]
224-
> Version 2.0 changed the JS API and moved the destination as the 2nd argument (which is different compared to v1.0 which had the destination inside the 1st argument array as the last element which was super confusing).
224+
> Version 2.0 changed the JS API and moved the destination as the 2nd argument (which is different compared to v1.0 which previously had its destination inside the 1st argument array as the last element which was super confusing).

0 commit comments

Comments
 (0)