Add config file support (#15)

1 files changed, 14 insertions, 0 deletions

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