Skip to content

Commit 46cc823

Browse files
KevenWMarkhamclaude
andcommitted
docs: add Windows Defender guide and PWA support documentation
- Add comprehensive Windows Defender installation guide - Step-by-step SmartScreen bypass instructions - Both standard and portable installation methods - Antivirus software handling for major vendors - File integrity verification with PowerShell - Troubleshooting section for common issues - IT administrator deployment guidance - FAQ explaining code signing and security - Update README with PWA support information - Add Progressive Web App feature in features list - Document iOS, Android, and tablet support via Vercel - Add installation instructions for mobile devices - Include Vercel deployment section in Building docs - Add PWA section to Tech Stack - Link to Windows Defender guide from Quick Start This addresses common Windows installation concerns and documents the application's mobile/tablet accessibility via PWA deployment. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 7be99c0 commit 46cc823

File tree

2 files changed

+615
-0
lines changed

2 files changed

+615
-0
lines changed

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ An advanced desktop application that converts video/audio files into searchable,
2020
- 💰 **Cost Tracking** - Real-time token usage and monthly billing breakdown
2121
- 📤 **Multiple Export Formats** - TXT, JSON, SRT, VTT formats
2222
- 🖥️ **Cross-Platform** - Available for Windows, macOS, and Linux
23+
- 📱 **Progressive Web App (PWA)** - Install on iOS, Android, and tablets via Vercel deployment
2324
-**High Performance** - Virtual scrolling handles 10,000+ entries smoothly
2425

2526
## 📸 Screenshots
@@ -30,12 +31,26 @@ An advanced desktop application that converts video/audio files into searchable,
3031

3132
### For End Users
3233

34+
**Desktop Applications:**
35+
3336
Download the latest release for your platform:
3437

3538
- **Windows**: [Transcript Parser-Setup-1.0.0.exe](https://github.com/KevenWMarkham/transcript-parser/releases)
39+
- See [Windows Defender Installation Guide](docs/windows-defender-installation.md) for help with security warnings
3640
- **macOS**: [Transcript Parser-1.0.0.dmg](https://github.com/KevenWMarkham/transcript-parser/releases)
3741
- **Linux**: [Transcript Parser-1.0.0.AppImage](https://github.com/KevenWMarkham/transcript-parser/releases)
3842

43+
**Progressive Web App (PWA):**
44+
45+
Access Transcript Parser on any device via our Vercel deployment:
46+
47+
- **Web App**: [https://transcript-parser.vercel.app](https://transcript-parser.vercel.app) _(link to be updated)_
48+
- **iOS**: Visit the web app in Safari → Tap Share → "Add to Home Screen"
49+
- **Android**: Visit the web app in Chrome → Tap menu → "Install app" or "Add to Home Screen"
50+
- **Tablets**: Full responsive support for iPad, Android tablets, and more
51+
52+
The PWA provides the same features as the desktop app with the convenience of installation directly from your browser.
53+
3954
See the [User Manual](docs/user-manual.md) for detailed usage instructions.
4055

4156
### For Developers
@@ -602,6 +617,14 @@ If any hook fails, the commit will be rejected. Fix the issues and try again.
602617
- **Commitlint**: Commit message validation
603618
- **lint-staged**: Run linters on staged files only
604619
620+
### Progressive Web App (PWA)
621+
622+
- **vite-plugin-pwa**: PWA plugin for Vite
623+
- **Service Workers**: Offline support and caching
624+
- **Web App Manifest**: Install to home screen capability
625+
- **Vercel**: Cloud deployment platform for mobile/tablet access
626+
- **Responsive Design**: Mobile-first approach with Tailwind CSS
627+
605628
## Tailwind CSS & shadcn/ui
606629
607630
This project uses Tailwind CSS for styling and shadcn/ui for pre-built, customizable components.
@@ -1244,6 +1267,43 @@ Output files in `dist/`:
12441267
- `Transcript Parser-X.X.X.AppImage` - AppImage
12451268
- `transcript-parser_X.X.X_amd64.deb` - Debian package
12461269

1270+
### Deploying to Vercel (PWA)
1271+
1272+
The application is configured as a Progressive Web App and can be deployed to Vercel for mobile and tablet access:
1273+
1274+
**Deploy via Vercel CLI:**
1275+
1276+
```bash
1277+
# Install Vercel CLI (if not already installed)
1278+
npm install -g vercel
1279+
1280+
# Deploy to production
1281+
vercel --prod
1282+
```
1283+
1284+
**Deploy via GitHub:**
1285+
1286+
1. Push your code to GitHub
1287+
2. Visit [vercel.com](https://vercel.com) and sign in
1288+
3. Import your repository
1289+
4. Vercel will automatically detect the Vite configuration
1290+
5. Deploy with default settings
1291+
1292+
**PWA Features:**
1293+
1294+
- **Offline Support**: Service worker caches assets for offline use
1295+
- **Install Prompt**: Users can install the app to their home screen
1296+
- **Mobile Optimized**: Fully responsive design for all screen sizes
1297+
- **Push Notifications**: (Future feature)
1298+
1299+
**Accessing on Mobile Devices:**
1300+
1301+
- **iOS (Safari)**: Tap Share → "Add to Home Screen"
1302+
- **Android (Chrome)**: Tap menu (⋮) → "Install app"
1303+
- **Tablets**: Works on iPad, Android tablets, and Surface devices
1304+
1305+
The PWA provides the same features as the desktop application with the convenience of running in any modern browser.
1306+
12471307
### Build Configuration
12481308

12491309
Electron Builder is configured in `package.json` under the `"build"` field:

0 commit comments

Comments
 (0)