diff --git a/README.md b/README.md index 75d2d42..4a64b2c 100644 --- a/README.md +++ b/README.md @@ -21,24 +21,31 @@ go build -o canvasarchiver ./cmd/canvasarchiver ./canvasarchiver ``` - Or + Or for files-only mode: ```bash ./canvasarchiver -fo ``` - For files-only mode. 2. On first run, you'll be prompted to authenticate: - Visit the provided OAuth URL - Authorize the application - Copy the authorization code back to the terminal -3. Enter your Course ID when prompted +3. Enter your Course ID when prompted (or use `-me` to download all enrolled courses) 4. The tool will download: - Regular course files (to `Course Files/`) - Module content (to `Modules/`) - Panopto recordings (to `Recordings/`) +### Flags + +| Flag | Description | +|------|-------------| +| `-fo` | Files only mode - download all files to a single directory without module structure | +| `-me` | Download all enrolled courses | +| `-n` | Prefix modules with order numbers `[1]`, `[2]`, etc. | + ## Configuration