From d94286f73a71d2be4b45d4855422045a3ee1b546 Mon Sep 17 00:00:00 2001 From: Tyler Dane Date: Tue, 20 Jan 2026 20:44:09 -0600 Subject: [PATCH 1/3] Revise README structure and content Updated README with new headings and simplified content. --- README.md | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b338b56bb..16cd6b8d6 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,21 @@ _A minimal task manager for engineers._ -_All your tasks & events in one place_ - _Organize your day and stay on track_ -https://github.com/user-attachments/assets/ba7b91b9-1984-49f2-afc6-7fcda1100b31 - ---- - -## Benefits +---- -### 🧘 Get clear +**Get clear**: Plan your Month β†’ Week β†’ Day β†’ Now -Plan your Month β†’ Week β†’ Day β†’ Now +**Simplify**: One app for tasks & events -### 1️⃣ Simplify your life +**Go fast**: Shortcuts, command palette, lightweight code -One app for tasks, events, and plans +**Keep your GCal**: Events sync to Google Calendar\* -### ⚑ Go fast - -Shortcuts, command palette, lightweight code - -### πŸ”„ Keep your GCal +https://github.com/user-attachments/assets/ba7b91b9-1984-49f2-afc6-7fcda1100b31 -Events sync to Google Calendar\* +--- ## Features From 602e50db64e2b40405841838c42f1a9df0f555fd Mon Sep 17 00:00:00 2001 From: Tyler Dane Date: Tue, 20 Jan 2026 21:45:39 -0600 Subject: [PATCH 2/3] Revise README for improved clarity and detail Updated the README to enhance clarity and detail about the Compass Calendar features and usage. --- README.md | 106 +++++++++++++++++++++++++++++------------------------- 1 file changed, 58 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 16cd6b8d6..2c66896ca 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,84 @@ # 🧭 Compass Calendar -_A minimal task manager for engineers._ +**A minimalist task manager designed for engineers.** -_Organize your day and stay on track_ +All your tasks and events in one place. Organize your day, stay on track, and ship more code. ----- - -**Get clear**: Plan your Month β†’ Week β†’ Day β†’ Now - -**Simplify**: One app for tasks & events +## Why Use Compass? -**Go fast**: Shortcuts, command palette, lightweight code +It'll help you focus and ship faster: +- **Plan faster**: Organize your Month β†’ Week β†’ Day β†’ Now in minutes. +- **Keyboard-first**: Shortcuts and command palette for lightning-fast navigation. +- **Private & Offline**: Runs fully local in your browser, with optional Google Calendar sync. +- **No bloat**: No AI β€” just a clean, minimal interface to help you get things done. -**Keep your GCal**: Events sync to Google Calendar\* +Join thousands of engineers who are staying organized and productive with Compass. https://github.com/user-attachments/assets/ba7b91b9-1984-49f2-afc6-7fcda1100b31 ---- +---- ## Features -### The unique stuff +### The Unique Stuff + +- **Day Mode**: See your tasks and events side-by-side +- **Now Mode**: Lock-in on a single task +- **Custom Note**: Display a personal note-to-self for motivation or reminders +- **Someday/Maybe List**: Organize future tasks without cluttering your schedule +- **One-Click Adjustments**: Move events forwards or back effortlessly -- β˜€οΈ Day mode: See your tasks and events side-by-side -- 🎯 Now mode: Lock-in on a single task -- ✍️ Display custom note-to-self -- β˜‘οΈ Organize tasks in a Someday / Maybe list -- ⏩ Move an event forward/back with one click +### The Essentials -### The basics +- Recurring events +- Command palette +- Event tagging, resizing, duplicating, reordering +- Drag & drop +- 2-way sync with Google Calendar (hosted or local via Ngrok) +- Google OAuth authentication +- User session management with Supertokens +- Email capture via Kit -- πŸ”„ Recurring events -- ⚑ Command palette -- ⚑ Shortcuts -- πŸ•’ Display events in local time -- 🏷️ Tagging events -- πŸ–οΈ Resizing events -- πŸ–οΈ Duplicating events -- πŸ–οΈ Reordering tasks -- πŸ–οΈ Drag & drop -- πŸ”„ **Hosted** 2-way sync with Google Calendar -- πŸ”„ **Local** 2-way sync with Google Calendar (Ngrok proxy) -- πŸ” Google OAuth authentication -- πŸ” User session management (Supertokens) -- βœ‰οΈ Email capture (Kit) +### Current Limitations -### Limitations +- Only supports primary Google Calendar (no sub-calendars) +- No sharing, locations, reminders, or mobile app (yet!) -Features we don't support yet: +We're actively working on improvements – check out our [roadmap](https://github.com/orgs/SwitchbackTech/projects/4). -- πŸ“‚ Sub-calendars (\*only primary calendar is supported) -- πŸ”— Sharing -- πŸ“ Location -- ⏰ Reminders -- πŸ“± Mobile app +## Getting Started -## Next Steps +### Try It Online +Head over to [app.compasscalendar.com](https://app.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme) -- 🧭 [Try the app](https://app.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme): Give it a spin before setting it up locally. +No signup required β€” start planning instantly! -- πŸ“ƒ [Read the technical docs](https://docs.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme): All the info you'd need to get started, including guides on how to install, test, build, deploy, and contribute. +### Run Locally +Want to poke around or run it self-hosted? -- πŸ“˜ [Read the handbook](https://compasscalendar.notion.site/?utm_source=github&utm_medium=referral&utm_campaign=readme): Why Compass exists and how it fits into our loooooong-term vision. +[Read the technical docs](https://docs.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme): All the info you'd need to get started, including guides on how to install, test, build, deploy, and contribute. -- πŸ‘€ Stay in touch: [GitHub Discussions](https://github.com/SwitchbackTech/compass/discussions), [X (Twitter)](https://x.com/CompassCalendar), [YouTube](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w), [LinkedIn](https://www.linkedin.com/company/compass-calendar) ## Tech Stack +- **Frontend**: React, Redux, Tailwind CSS, TypeScript, Webpack +- **Backend**: Node.js, Express, TypeScript, MongoDB +- **Integrations**: Google Calendar API, Google OAuth2, Socket.io +- **Testing**: Jest, React Testing Library +- **Other**: Yarn workspaces for monorepo management + +## Contributing +We love contributions! Whether it's bug fixes, new features, or documentation improvements, your help makes Compass better for everyone. + +Issues: Check open issues or create a new one. +Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute). +Discussions: Join the conversation on GitHub Discussions. + +First-time contributors? Look for issues labeled "good first issue"! + +## Community & Resources +- **Handbook**: [compasscalendar.notion.site](https://compasscalendar.notion.site/Compass-Handbook-26b237bde8f4805c9a56de6db3a7993d/?utm_source=github&utm_medium=referral&utm_campaign=readme) +- **Twitter**: [@CompassCalendar](https://x.com/CompassCalendar) +- **Youtube**: [Playlist](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w) +- **LinkedIn**: [Compass Calendar](https://www.linkedin.com/company/compass-calendar) -![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white) ![Google Cloud](https://img.shields.io/badge/GoogleCloud-%234285F4.svg?style=for-the-badge&logo=google-cloud&logoColor=white) ![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white) ![Redux](https://img.shields.io/badge/redux-%23593d88.svg?style=for-the-badge&logo=redux&logoColor=white) ![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB) ![Socket.io](https://img.shields.io/badge/Socket.io-black?style=for-the-badge&logo=socket.io&badgeColor=010101) -![Webpack](https://img.shields.io/badge/webpack-%238DD6F9.svg?style=for-the-badge&logo=webpack&logoColor=black) ![Yarn](https://img.shields.io/badge/yarn-%232C8EBB.svg?style=for-the-badge&logo=yarn&logoColor=white) ![Styled Components](https://img.shields.io/badge/styled--components-DB7093?style=for-the-badge&logo=styled-components&logoColor=white) ![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white) -![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white) -![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white) -![Ngrok](https://img.shields.io/badge/ngrok-1F1F1F?style=for-the-badge&logo=ngrok&logoColor=white) +Star the repo for good luck. From 7ce75a76038c9a058035d81ac9428e6a7416c4c5 Mon Sep 17 00:00:00 2001 From: Tyler Dane Date: Sun, 1 Feb 2026 11:39:53 -0800 Subject: [PATCH 3/3] Update README for improved clarity and detail on features and usage --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2c66896ca..8a46d41bd 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,17 @@ All your tasks and events in one place. Organize your day, stay on track, and sh ## Why Use Compass? It'll help you focus and ship faster: + - **Plan faster**: Organize your Month β†’ Week β†’ Day β†’ Now in minutes. - **Keyboard-first**: Shortcuts and command palette for lightning-fast navigation. - **Private & Offline**: Runs fully local in your browser, with optional Google Calendar sync. - **No bloat**: No AI β€” just a clean, minimal interface to help you get things done. -Join thousands of engineers who are staying organized and productive with Compass. +Join thousands of engineers who are staying organized and productive with Compass. https://github.com/user-attachments/assets/ba7b91b9-1984-49f2-afc6-7fcda1100b31 ----- +--- ## Features @@ -49,17 +50,19 @@ We're actively working on improvements – check out our [roadmap](https://githu ## Getting Started ### Try It Online + Head over to [app.compasscalendar.com](https://app.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme) No signup required β€” start planning instantly! ### Run Locally + Want to poke around or run it self-hosted? [Read the technical docs](https://docs.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme): All the info you'd need to get started, including guides on how to install, test, build, deploy, and contribute. - ## Tech Stack + - **Frontend**: React, Redux, Tailwind CSS, TypeScript, Webpack - **Backend**: Node.js, Express, TypeScript, MongoDB - **Integrations**: Google Calendar API, Google OAuth2, Socket.io @@ -67,6 +70,7 @@ Want to poke around or run it self-hosted? - **Other**: Yarn workspaces for monorepo management ## Contributing + We love contributions! Whether it's bug fixes, new features, or documentation improvements, your help makes Compass better for everyone. Issues: Check open issues or create a new one. @@ -76,6 +80,7 @@ Discussions: Join the conversation on GitHub Discussions. First-time contributors? Look for issues labeled "good first issue"! ## Community & Resources + - **Handbook**: [compasscalendar.notion.site](https://compasscalendar.notion.site/Compass-Handbook-26b237bde8f4805c9a56de6db3a7993d/?utm_source=github&utm_medium=referral&utm_campaign=readme) - **Twitter**: [@CompassCalendar](https://x.com/CompassCalendar) - **Youtube**: [Playlist](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w)