zyl/pupdate
1
0
Fork 0
mirror of https://github.com/zyllian/pupdate.git synced 2025-01-18 11:47:24 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

add config section to readme

Browse source
This commit is contained in:
zyl 2024-10-08 16:43:42 -07:00
parent f8fad36610
commit 1201971510
Signed by: zyl
SSH key fingerprint: SHA256:uxxbSXbdroP/OnKBGnEDk5q7EKB2razvstC/KmzdXXs
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -5,3 +5,14 @@ simple helper utility to update remote systems alongside the local system easily
## usage ## 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). 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.
```