From 120197151051c247cab47b2afeb74be1d36562c5 Mon Sep 17 00:00:00 2001
From: zyl <z@zyl.gay>
Date: Tue, 8 Oct 2024 16:43:42 -0700
Subject: [PATCH] add config section to readme

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index eb956e3..ee0bfe1 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,14 @@ simple helper utility to update remote systems alongside the local system easily
 ## usage
 
 run `pupdate -h` for help with arguments. with no arguments, pupdate will update the local system and any remotes configured in the config file (default ~/.pupdate).
+
+## config
+
+```json
+{
+	"remotes": ["username@remote"],
+	"log_dir": "/path/to/log/directory"
+}
+
+if `log_dir` is missing and is not provided when the command is run, no logs from pupdating will be saved.
+```