Skip to content

Commit ba92e5e

Browse files
authored
Revise README for better clarity and structure (#1269)
Updated the README to improve clarity and organization of features and benefits.
1 parent 73645e3 commit ba92e5e

File tree

1 file changed

+45
-28
lines changed

1 file changed

+45
-28
lines changed

README.md

Lines changed: 45 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,38 @@
11
# 🧭 Compass Calendar
22

3-
_Compass is a weekly planner that integrates with Google Calendar._
3+
_A focused workspace for organizing your day and staying on track; All your events & tasks in one place_
4+
5+
https://github.com/user-attachments/assets/ba7b91b9-1984-49f2-afc6-7fcda1100b31
46

5-
<img width="1494" alt="Glimpsed" src="https://github.com/user-attachments/assets/c0a22b46-f0eb-4b0c-8a7b-942f142947a5" />
67

78
---
89

9-
![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)
10-
![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)
11-
![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
12-
![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white)
13-
![Ngrok](https://img.shields.io/badge/ngrok-1F1F1F?style=for-the-badge&logo=ngrok&logoColor=white)
1410

11+
## Benefits
12+
13+
### 🧘 Get clear
14+
Plan your Month → Week → Day → Now
15+
16+
### 1️⃣ Simplify your life
17+
One app for tasks, events, and plans
18+
19+
### ⚡ Go fast
20+
Shortcuts, command palette, lightweight code
21+
22+
### 🔄 Keep your GCal
23+
Events sync to Google Calendar*
24+
1525
## Features
1626

17-
The basics:
27+
### The unique stuff
28+
29+
- ☀️ Day mode: See your tasks and events side-by-side
30+
- 🎯 Now mode: Lock-in on a single task
31+
- ✍️ Display custom note-to-self
32+
- ☑️ Organize tasks in a Someday / Maybe list
33+
- ⏩ Move an event forward/back with one click
34+
35+
### The basics
1836

1937
- 🔄 Recurring events
2038
- ⚡ Command palette
@@ -25,38 +43,37 @@ The basics:
2543
- 🖍️ Duplicating events
2644
- 🖍️ Reordering tasks
2745
- 🖍️ Drag & drop
28-
29-
The unique stuff:
30-
31-
- ✍️ Display custom note-to-self
32-
- ☑️ Organize tasks in a Someday / Maybe list
33-
- ⏩ Move an event forward/back with one click
34-
- ☀️ Day view: see your tasks and events side-by-side
35-
36-
Integrations:
37-
3846
- 🔄 **Hosted** 2-way sync with Google Calendar
3947
- 🔄 **Local** 2-way sync with Google Calendar (Ngrok proxy)
4048
- 🔐 Google OAuth authentication
4149
- 🔐 User session management (Supertokens)
4250
- ✉️ Email capture (Kit)
4351

44-
## Limitations
52+
### Limitations
4553

4654
Features we don't support yet:
4755

48-
- Sub-calendars (only primary calendar is supported). Coming in fall 2025.
49-
- Sharing
50-
- Location
51-
- Reminders
52-
- Mobile app
56+
- 📂 Sub-calendars (*only primary calendar is supported)
57+
- 🔗 Sharing
58+
- 📍 Location
59+
- Reminders
60+
- 📱 Mobile app
5361

5462
## Next Steps
5563

56-
🧭 [Use the app](https://app.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme): If you want to try it out for yourself before setting it up locally.
64+
- 🧭 [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.
65+
66+
- 📃 [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.
5767

58-
📃 [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.
68+
- 📘 [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.
5969

60-
📘 [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.
70+
- 👀 Stay in touch: [Discord](https://www.discord.gg/H3DVMnKmUd), [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)
71+
72+
## Tech Stack
73+
74+
![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)
75+
![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)
76+
![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
77+
![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white)
78+
![Ngrok](https://img.shields.io/badge/ngrok-1F1F1F?style=for-the-badge&logo=ngrok&logoColor=white)
6179

62-
👀 Stay in touch: [Discord](https://www.discord.gg/H3DVMnKmUd), [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)

0 commit comments

Comments
 (0)