Skip to content

Commit 9122067

Browse files
authored
📜 Docs: update README (#404)
* docs: update README * Docs: update screenshot in README * docs: update feature list and add beta status to production app link * docs: Update README.md with new doc screenshot
1 parent 3c5caa2 commit 9122067

File tree

2 files changed

+24
-16
lines changed

2 files changed

+24
-16
lines changed

README.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# 🧭 Compass Calendar
22

3-
## Overview
3+
_Compass is a weekly planner that integrates with Google Calendar._
4+
<img width="1494" alt="Glimpsed" src="https://github.com/user-attachments/assets/c0a22b46-f0eb-4b0c-8a7b-942f142947a5" />
45

5-
_Compass is a weekly calendar app that integrates with Google Calendar._
6+
---
67

78
![Build](https://github.com/SwitchbackTech/compass/actions/workflows/test.yml/badge.svg)
89

@@ -11,24 +12,32 @@ _Compass is a weekly calendar app that integrates with Google Calendar._
1112
![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
1213
![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white)
1314

14-
![Compass_Highlights](https://github.com/SwitchbackTech/compass/assets/30163055/00543d34-5dfc-47d5-9b83-d84d4c748391)
15-
1615
## Features
1716

18-
- 🔄 2-way sync with Google Calendar
19-
- 🔄 Recurring events
17+
The basics:
18+
19+
- 🔄 Recurring events (limited support)
2020
- ⚡ Command palette
2121
- ⚡ Shortcuts
2222
- 🕒 Display events in local time
2323
- 🏷️ Tagging events
2424
- 🖍️ Resizing events
25+
- 🖍️ Duplicating events
2526
- 🖍️ Reordering tasks
2627
- 🖍️ Drag & drop
27-
- ✉️ Email capture
28-
- 🔐 Google OAuth authentication
29-
- 🔐 User session management
3028

31-
Visit [app.compasscalendar.com](https://app.compasscalendar.com) to see them all in action with your own events
29+
The unique stuff:
30+
31+
- ✍️ Display your custom note-to-self
32+
- ☑️ Someday / Maybe todo list
33+
- ⏩ Move an event forward/back with one click
34+
35+
Integrations:
36+
37+
- 🔄 2-way sync with Google Calendar
38+
- 🔐 Google OAuth authentication
39+
- 🔐 User session management (Supertokens)
40+
- ✉️ Email capture (Kit)
3241

3342
## Limitations
3443

@@ -41,17 +50,17 @@ you need yet, including:
4150
- Reminders
4251
- Mobile app
4352

44-
## Documentation
53+
## Get Started
4554

46-
All the docs are at [docs.compasscalendar.com](https://docs.compasscalendar.com), including guides on how to install, test, build, deploy, and contribute
55+
All the info you'd need to get started is at [docs.compasscalendar.com](https://docs.compasscalendar.com), including guides on how to install, test, build, deploy, and contribute.
4756

48-
[![TheDocs](https://github.com/SwitchbackTech/compass/assets/30163055/b9577876-43af-49eb-830b-df0644c1af8f)](https://docs.compasscalendar.com)
57+
[![NextStep-TheDocs](https://github.com/user-attachments/assets/3a41c035-6058-4cb0-97d0-4a03388355aa)](https://docs.compasscalendar.com)
4958

5059
## Links
5160

5261
📃 [Compass Docs](https://docs.compasscalendar.com)
5362

54-
🔵 [Production App](https://app.compasscalendar.com)
63+
🔵 [Production App](https://app.compasscalendar.com) (Closed beta)
5564

5665
🎬 [Compass on YouTube](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w)
5766

packages/core/src/mappers/map.event.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,7 @@ const getPriority = (gEvent: gSchema$Event): Priorities => {
126126
}
127127
// Found a priority that doesn't match enum, set to unassigned
128128
console.warn(
129-
`Found a priority that doesn't match enum: ${priority}`,
130-
gEvent,
129+
`Found a priority that doesn't match enum: ${priority}. Using ${Priorities.UNASSIGNED} instead. (gEvent.id: ${gEvent.id})`,
131130
);
132131
return Priorities.UNASSIGNED;
133132
}

0 commit comments

Comments
 (0)