Rewrite README with plain-language instructions

This commit is contained in:
2026-06-29 19:37:57 -05:00
parent e2885e366c
commit a26eb39ccb
+60 -21
View File
@@ -1,28 +1,67 @@
# FTP Uploader
# PDF FTP Uploader
Drop PDFs in a folder, double-click `upload.bat` to send them to FTP, done.
Uploaded files are moved to an `archive` subfolder automatically.
This tool sends PDF files to a server automatically. Just drop your PDFs in the right folder and double-click to upload. Done.
## Setup (per practice folder)
---
1. Copy `upload.bat`, `upload.ps1`, and `ftp-config.ini` into the folder
2. Edit `ftp-config.ini` with the FTP credentials for that practice
3. Drop PDFs into the folder
4. Double-click `upload.bat`
## How to use it every day
## ftp-config.ini options
1. Drop your PDF files into the practice folder (e.g. `Acme Dental\`)
2. Double-click **upload.bat** inside that folder
3. A window will open showing the progress
4. When it says **Done**, close the window — your files have been sent and moved to the `archive` folder automatically
| Key | Required | Description |
|-----|----------|-------------|
| `host` | Yes | FTP server hostname or IP |
| `port` | No | Port (default: 21) |
| `username` | Yes | FTP username |
| `password` | Yes | FTP password |
| `remote_path` | No | Remote folder path (default: `/`) |
| `tls` | No | Set to `true` for FTPS (default: `false`) |
To upload **all practices at once**, double-click **run-all.bat** in the main folder instead.
## Behaviour
---
- Only `.pdf` files in the folder are uploaded (not subfolders)
- Files that fail are left in place for the next run to retry
- Successfully uploaded files move to `archive\`
## First-time setup for a new practice
You only do this once per practice.
1. Create a new folder with the practice name (e.g. `Bright Smiles\`)
2. Copy these three files into it:
- `upload.bat`
- `upload.ps1`
- `ftp-config.ini`
3. Open `ftp-config.ini` in Notepad and fill in the details:
```
host= ← the FTP server address (given to you by the practice)
port=21 ← leave this as 21 unless told otherwise
username= ← your FTP username
password= ← your FTP password
remote_path=← the folder on their server (e.g. /incoming) — leave as / if unsure
tls=false ← change to true if the practice uses FTPS (secure FTP)
```
4. Save the file and you're ready to go
---
## Folder layout
```
Main Folder\
run-all.bat ← uploads everything at once
run-all.ps1
Acme Dental\
upload.bat ← uploads just this practice
upload.ps1
ftp-config.ini ← this practice's server details
report1.pdf
archive\ ← uploaded files go here automatically
Bright Smiles\
upload.bat
upload.ps1
ftp-config.ini
...
```
---
## Something went wrong?
- **A file failed to upload** — it stays in the folder. Just double-click upload.bat again to retry.
- **The window closed too fast** — right-click `upload.bat`, choose *Run as administrator* and try again.
- **Not sure if it worked** — check the `archive` folder. Files only move there after a successful upload.