From 61607e023fbb916f376a7070f8b1ffd6ffe16849 Mon Sep 17 00:00:00 2001 From: Ellie Huxtable Date: Wed, 10 Mar 2021 21:24:08 +0000 Subject: Add config file support (#15) --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 5c440417..30e6dd97 100644 --- a/README.md +++ b/README.md @@ -179,6 +179,20 @@ $ atuin stats all +---------------------+-------+ ``` +## Config + +A'tuin is configurable via TOML. The file lives at ` ~/.config/atuin/config.toml`, +and looks like this: + +``` +[local] +dialect = "uk" # or us. sets the date format used by stats +server_address = "https://atuin.elliehuxtable.com/" # the server to sync with + +[local.db] +path = "~/.local/share/atuin/history.db" # the local database for history +``` + ## ...what's with the name? A'tuin is named after "The Great A'tuin", a giant turtle from Terry Pratchett's -- cgit v1.3.1