From 831cc98c24feefe259585f26ce71ca805282c616 Mon Sep 17 00:00:00 2001 From: mundry <1453314+mundry@users.noreply.github.com> Date: Fri, 22 Apr 2022 22:17:05 +0200 Subject: [PATCH] Fix typos in the docs. (#171) Co-authored-by: mundry --- docs/config.md | 2 +- docs/search.md | 2 +- docs/sync.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/config.md b/docs/config.md index 8b5fa29..117e93e 100644 --- a/docs/config.md +++ b/docs/config.md @@ -58,7 +58,7 @@ sync_address = "https://api.atuin.sh" ### `sync_frequency` How often to automatically sync with the server. This can be given in a -"human readable" format. For example, `10s`, `20m`, `1h`, etc. Defaults to `1h`. +"human-readable" format. For example, `10s`, `20m`, `1h`, etc. Defaults to `1h`. If set to `0`, Atuin will sync after every command. Some servers may potentially rate limit, which won't cause any issues. diff --git a/docs/search.md b/docs/search.md index b103400..a56a9f1 100644 --- a/docs/search.md +++ b/docs/search.md @@ -6,7 +6,7 @@ atuin search Atuin search also supports wildcards, with either the `*` or `%` character. By default, a prefix search is performed (ie, all queries are automatically -appended with a wildcard. +appended with a wildcard). | Arg | Description | | ------------------ | ----------------------------------------------------------------------------- | diff --git a/docs/sync.md b/docs/sync.md index f234114..7655ed1 100644 --- a/docs/sync.md +++ b/docs/sync.md @@ -1,6 +1,6 @@ # `atuin sync` -Atuin can backup your history to a server, and use this to ensure multiple +Atuin can back up your history to a server, and use this to ensure multiple machines have the same shell history. This is all encrypted end-to-end, so the server operator can _never_ see your data! @@ -47,7 +47,7 @@ Never share this with anyone! ## Login -If you want to login to a new machine, you will require your encryption key +If you want to log in to a new machine, you will require your encryption key (`atuin key`). ```