docs: Complete README Makeover for Squadron 2.0 (Issue #4) #15
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Replace CLI-focused README with desktop app documentation - Add 6-terminal grid, multi-provider support, git worktrees docs - Include new architecture diagram (Electron + Python backend) - Add installation instructions for desktop app - Add electron-builder config for Mac/Windows/Linux builds - Bump version to 2.0.0 - Add platform-specific build scripts Closes #4
Settings Panel Expansion: - Add 11 integration keys: Slack, Discord (2), Jira (3), Linear, GitHub + AI providers - Categorized sidebar UI: AI Providers, Communication, Project Management, Development - Project folder selection with native dialog - Export .env file for Python backend integration Onboarding Wizard: - 3-step first-launch flow: Choose AI Provider → Enter API Key → Select Project - Skip option for power users - Encrypted key storage on first run Technical: - New settings-store.ts with INTEGRATION_KEYS config - 7 new IPC methods in preload.ts - 6 new handlers in main.ts + folder dialog - OnboardingWizard.tsx component - First-launch detection in App.tsx Part of Issue #4 (Marketing & Onboarding)
- Remove PyPI badge and pip install references - Add screenshot placeholders for terminals, kanban, settings, onboarding - Update badges to GitHub releases/downloads - Mark onboarding wizard as complete in roadmap - Add coming soon: AI Merge, Insights, Changelog - Bump setup.py version to 2.0.0 - Cleaner architecture diagram
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Complete README overhaul to reflect Squadron 2.0 as a desktop application.
Changes
README.md
New sections:
package.json
pm run electron:build:mac\ → .dmg (x64 + arm64)
pm run electron:build:win\ → .exe
pm run electron:build:linux\ → .AppImage
Stats
Closes #4