Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
timopruesse committed Apr 9, 2022
1 parent b07d5ef commit 762f6f5
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,9 @@ This command symlinks all the files from the source directory to the target dire
| src | source directory/file | ✅ | "./src/files" or "./src/test.txt" |
| target | target directory/file | ✅ | "/tmp/target" or "/tmp/new.txt" |
| ignore | list of files/directories to ignore | ➖ | ["dist", "package-lock.json"] |
| force | true/false | ➖ | |

> If `force` is set to `true`, existing files will be **removed** and replaced by the symlinks.

##### example

Expand All @@ -147,6 +150,7 @@ symlink:
src: "./src/files"
target: "/tmp/target"
ignore: ["dist", "package-lock.json"]
force: true
```

#### run
Expand Down

0 comments on commit 762f6f5

Please sign in to comment.