Skip to content

Commit

Permalink
document cktime state file
Browse files Browse the repository at this point in the history
  • Loading branch information
sanbornm committed Jul 14, 2023
1 parent 4aec645 commit e1c03e3
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,8 @@ It is common for an app to want to restart to apply the update. `go-selfupdate`

Or maybe you have a fancy graceful restart library/func:

u.OnSuccessfulUpdate = func() { gracefullyRestartMyApp() }
u.OnSuccessfulUpdate = func() { gracefullyRestartMyApp() }

## State

go-selfupdate will keep a Go time.Time formatted timestamp in a file named `cktime` in folder specified by `Updater.Dir`. This can be useful for debugging to see when the next update can be applied or allow other applications to manipulate it.

0 comments on commit e1c03e3

Please sign in to comment.