Skip to content

Commit 7faafa5

Browse files
committed
docs: update feature list and add beta status to production app link
1 parent 4cf814b commit 7faafa5

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
_Compass is a weekly planner that integrates with Google Calendar._
44
<img width="1494" alt="Glimpsed" src="https://github.com/user-attachments/assets/c0a22b46-f0eb-4b0c-8a7b-942f142947a5" />
55

6-
76
---
87

98
![Build](https://github.com/SwitchbackTech/compass/actions/workflows/test.yml/badge.svg)
@@ -15,19 +14,30 @@ _Compass is a weekly planner that integrates with Google Calendar._
1514

1615
## Features
1716

18-
- ✍️ Display your custom note-to-self
19-
- 🔄 2-way sync with Google Calendar
20-
- 🔄 Recurring events
17+
The basics:
18+
19+
- 🔄 Recurring events (limited support)
2120
- ⚡ Command palette
2221
- ⚡ Shortcuts
2322
- 🕒 Display events in local time
2423
- 🏷️ Tagging events
2524
- 🖍️ Resizing events
25+
- 🖍️ Duplicating events
2626
- 🖍️ Reordering tasks
2727
- 🖍️ Drag & drop
28-
- ✉️ Email capture
28+
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
2938
- 🔐 Google OAuth authentication
30-
- 🔐 User session management
39+
- 🔐 User session management (Supertokens)
40+
- ✉️ Email capture (Kit)
3141

3242
## Limitations
3343

@@ -40,17 +50,17 @@ you need yet, including:
4050
- Reminders
4151
- Mobile app
4252

43-
## Documentation
53+
## Get Started
4454

45-
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.
4656

4757
[![TheDocs](https://github.com/SwitchbackTech/compass/assets/30163055/b9577876-43af-49eb-830b-df0644c1af8f)](https://docs.compasscalendar.com)
4858

4959
## Links
5060

5161
📃 [Compass Docs](https://docs.compasscalendar.com)
5262

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

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

0 commit comments

Comments
 (0)