aboutsummaryrefslogtreecommitdiffstats
path: root/docs/config.md
diff options
context:
space:
mode:
authorEllie Huxtable <ellie@elliehuxtable.com>2022-10-14 10:59:21 +0100
committerGitHub <noreply@github.com>2022-10-14 10:59:21 +0100
commitf03f6e9ad74d8e1cf1fa33dc2c0c7c5dd7ae5c94 (patch)
treeaa03f60230b3bc96485806724383bfd6e4cc6b1d /docs/config.md
parentFix ZSH import print (diff)
downloadatuin-f03f6e9ad74d8e1cf1fa33dc2c0c7c5dd7ae5c94.zip
Add automatic update checking (#555)
* Add automatic update checking * Add setting to opt out of update checks * Document options * no * no * also no * Make clippy happy * Update atuin-client/src/settings.rs Co-authored-by: Conrad Ludgate <conradludgate@gmail.com> * fix features Co-authored-by: Conrad Ludgate <conradludgate@gmail.com> Co-authored-by: Conrad Ludgate <conrad.ludgate@truelayer.com>
Diffstat (limited to 'docs/config.md')
-rw-r--r--docs/config.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/config.md b/docs/config.md
index 42d8b0bc..13aabac2 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -47,6 +47,15 @@ true
auto_sync = true/false
```
+### `update_check`
+
+Configures whether or not to automatically check for updates. Defaults to
+true.
+
+```
+auto_sync = true/false
+```
+
### `sync_address`
The address of the server to sync with! Defaults to `https://api.atuin.sh`.