From a46f4a6f4a2327fd1df4b3fa3dcd3fef97feaefc Mon Sep 17 00:00:00 2001 From: haopengzhan Date: Sun, 23 Aug 2026 15:16:30 -0700 Subject: [PATCH] docs: enrich README with visual screenshot, non-developer download steps, and FAQ --- README.md | 49 ++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 38 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2a53938..22e5484 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ > **Save and back up all your child's precious preschool & daycare memories, high-resolution photos, HD videos, daily care logs, and developmental milestones from Brightwheel.** +![Brightwheel Exporter Dashboard Preview](screenshots/store_screenshot_1280x800.png) + --- ## ✨ Features @@ -22,20 +24,25 @@ --- -## 🚀 Installation (Load Unpacked in Chrome) +## 🚀 Installation (Takes 30 Seconds) -1. **Clone or download this repository:** - ```bash - git clone https://github.com/CoderSherlock/brightwheel-exporter.git - ``` -2. Open Google Chrome and navigate to: +### Option A: Download ZIP (No Coding or Git Required) +1. Download the latest source code by clicking the green **Code** button at the top of this page → **[Download ZIP](https://github.com/CoderSherlock/brightwheel-exporter/archive/refs/heads/main.zip)**. +2. Unzip the downloaded `.zip` file on your computer. +3. Open Google Chrome and navigate to: ``` chrome://extensions/ ``` -3. Enable **Developer mode** using the toggle switch in the top-right corner. -4. Click the **Load unpacked** button in the top-left corner. -5. Select the cloned `brightwheel-exporter` directory. -6. The **Brightwheel Exporter** icon will now appear in your browser toolbar! +4. Enable **Developer mode** using the toggle switch in the top-right corner. +5. Click the **Load unpacked** button in the top-left corner. +6. Select the unzipped `brightwheel-exporter-main` folder. +7. 🎉 The **Brightwheel Exporter** icon will now appear in your browser toolbar! + +### Option B: Clone via Git (For Developers) +```bash +git clone https://github.com/CoderSherlock/brightwheel-exporter.git +``` +Then follow steps 3–6 above selecting the cloned directory. --- @@ -78,10 +85,30 @@ --- ## 🔒 Privacy & Security - + - **No Remote Servers**: This extension is 100% open source and runs entirely on your local machine. - **Session Authentication**: Uses your existing Brightwheel browser cookies securely. No logins or API keys are ever stored or shared. - **Direct S3/CDN Downloads**: Media files are downloaded directly from Brightwheel's official AWS S3 buckets and CloudFront distribution endpoints straight to your disk. +- **Auditable Source Code**: Because you load this unpacked from source, you can review every line of code in this repository. + +--- + +## ❓ Frequently Asked Questions (FAQ) + +
+Is my family's data safe and private? +Yes, 100%. This tool has no external backend, databases, or analytics. Everything runs entirely within your browser on your own machine. Data requests travel directly between your browser and Brightwheel/S3. +
+ +
+What is the best export mode for large photo & video feeds? +We strongly recommend choosing "Save Directly to Local Folder" in the dashboard. This streams media files straight to your hard drive using the modern File System Access API without storing giant ZIP files in browser RAM. +
+ +
+How do I view the exported offline archive? +Inside your exported folder or unzipped archive, double-click the index.html file. It opens a standalone gallery timeline that allows you to search captions, play videos, and filter milestones offline with no internet required. +
---