Skip to content

Commit 605f76b

Browse files
committed
update readme
1 parent e123082 commit 605f76b

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

readme.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,13 @@ curl https://raw.githubusercontent.com/jliocsar/timov/refs/heads/main/install.sh
88

99
```sh
1010
# In your .bashrc or .zshrc file
11-
alias notes="$HOME/.timov.sh"
11+
alias notes="code $HOME/.timov"
1212
```
13+
14+
## How it works
15+
16+
The Timov installer will create a cronjob entry, making the Timov main file run every 2 minutes.
17+
18+
The main file will then pull the latest changes from `git` and commit/push any pending changes (will also commit/push the conflicts if any).
19+
20+
Essentially your `.timov` directory will be the mirror of your remote directory in your `git` repository with your notes. Any change made in the local repository will be reflected in the remote when picked up by the cron.

0 commit comments

Comments
 (0)