Skip to content

Commit cc124b6

Browse files
committed
Update README
1 parent c81d830 commit cc124b6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,13 @@ This key is intentionally absent from pg2s3's configuration in order to require
5252
| `age_public_key` | No | Public key for backup encryption |
5353

5454
## Usage
55-
The pg2s3 command-line tool offers three commands:
55+
The pg2s3 command-line tool offers three mutually-exclusive actions:
5656
* `pg2s3 -backup` - Create a new backup and upload to S3
5757
* `pg2s3 -restore` - Download the latest backup from S3 and restore
5858
* `pg2s3 -prune` - Prune old backups from S3
5959

60+
If none of these are provided, the pg2s3 will attempt to run in scheduled mode: sleeping until `backup_schedule` arrives and then performaing a backup + prune.
61+
6062
## Local Development
6163
To develop and test locally, containers for [PostgreSQL](https://www.postgresql.org/) and [MinIO](https://min.io/) must be running:
6264
```

0 commit comments

Comments
 (0)