Skip to content

Commit 753187c

Browse files
committed
chore: README quick start
1 parent eea4cfe commit 753187c

1 file changed

Lines changed: 14 additions & 22 deletions

File tree

README.md

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,33 @@
1414

1515
A backup solution for web development projects: multiple source directories, full/incremental/differential backups, compression, integrity verification, and optional cloud (planned).
1616

17-
## Quick Start
17+
## Quick Start (clone and run in 2 minutes)
1818

19-
**Run directly (from the repo):**
19+
Clone, run install (sets permissions, creates dirs, checks tools), run tests, edit config, then backup.
2020

2121
```bash
22-
cd /path/to/backup-webdev
23-
./webdev-backup.sh # Interactive menu (press Enter for Quick Backup)
24-
./backup.sh --quick # Quick backup with defaults (no menu)
22+
git clone https://github.com/yourusername/backup-webdev.git
23+
cd backup-webdev
24+
./install.sh # Sets chmod +x, creates logs/test, checks tools (decline alias/security prompts if you prefer)
25+
./run-tests.sh # Verify it works (48 tests, no config needed)
2526
```
2627

27-
From the menu, **Quick Backup** is the default: press **Enter** to start a backup with your configured sources and destination. Quick backup shows the same per-folder progress (dashboard) as an interactive run—no prompts for project selection.
28-
29-
**Run from anywhere via alias** — add to `~/.bashrc` or `~/.zshrc`:
28+
Edit `config.sh` — set your **source** and **destination** paths (see [Configuration](#configuration)):
3029

3130
```bash
32-
alias webback='/path/to/backup-webdev/webdev-backup.sh'
31+
# In config.sh: DEFAULT_SOURCE_DIRS=("$HOME/Developer") # or your project dirs
32+
# DEFAULT_BACKUP_DIR="$HOME/backups" # where to store backups
3333
```
3434

35-
Use the real path to this cloned repo on your machine (e.g. `$HOME/backup-webdev` or `/Volumes/MyDrive/backup-webdev`). Then either open a new terminal or run `source ~/.zshrc` (or `source ~/.bashrc`) and use:
35+
Then run:
3636

3737
```bash
38-
webback
38+
./backup.sh --dry-run # Smoke test (no writes)
39+
./webdev-backup.sh # Interactive menu — press Enter for Quick Backup
40+
./backup.sh --quick # Direct quick backup (no menu)
3941
```
4042

41-
You can also run `./setup-alias.sh` from the repo to add the alias for you.
43+
**Optional:** Run `./setup-alias.sh` to add a `webback` alias. This is a run-from-repo tool — no system-wide install.
4244

4345
## Features
4446

@@ -53,16 +55,6 @@ You can also run `./setup-alias.sh` from the repo to add the alias for you.
5355
- **Bash** 3.2+ (macOS-compatible)
5456
- **tar**, **gzip** (required); **pigz**, **gnuplot**, **AWS CLI** (optional)
5557

56-
## Installation
57-
58-
```bash
59-
git clone https://github.com/yourusername/backup-webdev.git
60-
cd backup-webdev
61-
./install.sh
62-
```
63-
64-
Manual: `chmod +x *.sh`, then `./setup-alias.sh` and `./check-config.sh`.
65-
6658
## Usage
6759

6860
- **Menu:** `./webdev-backup.sh` — option **1** (Quick Backup) is the default; press Enter to run it.

0 commit comments

Comments
 (0)