Skip to content

Commit d059d35

Browse files
authored
Revise README content for clarity and formatting
Updated wording for clarity and consistency in README.
1 parent 90f30f2 commit d059d35

1 file changed

Lines changed: 21 additions & 43 deletions

File tree

README.md

Lines changed: 21 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,50 @@
11
# Compass Calendar
22

3-
A simple app that helps you manage your time.
3+
A simple calendar that helps you manage your time.
44

5-
## Why Try Compass?
5+
## Why try compass?
66

7-
### You'll get more done:
7+
### You'll get more done
88

99
- The **first-class shortcuts** will make it a breeze to stay on top of your schedule.
1010
- The **minimal UI** will help you focus on what matters: your events.
1111
- The **Google Calendar two-way sync** will ensure you don't miss anything.
1212

13-
### It'll be around for the long-term:
13+
### It'll be around for the long-term
1414

1515
- **We're bootstrapped.** While VC-backed teams think in terms of months and funding rounds, we think in terms of decades and profit. We don't need to make $1B in 5 years or sell your data to an acquirer. As long as we keep users like you happy, we'll be fine.
16-
- **We have a plan**: Our long-term [vision](https://alpaca-ty.notion.site/about-us) will keep us busy for generations. Our practical roadmap and focus on profitability will keep our feet on the ground along the way.
16+
- **We have a plan.** Our long-term [vision](https://alpaca-ty.notion.site/about-us) will keep us busy for generations. Our practical roadmap and focus on profitability will keep our feet on the ground along the way.
1717

1818
### It'll help others
19-
We donate 10% of revenue to support mental health programs in our home city of Bozeman, Montana. Your support helps us help others in need.
19+
We donate 10% of revenue to support mental health programs in our home city of Bozeman, Montana. Your support helps us support others in need.
2020

2121
## Features
2222

23-
- Recurring events
24-
- Command palette
25-
- Event tagging, resizing, duplicating, reordering
26-
- Drag & drop
27-
- Google Calendar sync
28-
- User sessions
23+
Cool things you can do with in Compass
2924

30-
## The Limitations
25+
- Find the perfect slot for an event with your keyboard: `SHIFT` + `` `` `` ``
26+
- Do everything from the cmd palette
27+
- Edit events smoothly
28+
- Google Calendar sync
3129

32-
Things we don't support (yet):
30+
Things you can't do in Compass (yet):
3331

34-
- Outlook or iCal
35-
- Sharing, reminders, locations
36-
- Mobile app
32+
- See attendees, reminders, locations, and meeting links
33+
- See your Outlook events
3734

38-
## Tech Stack
35+
## Tech stack
3936

4037
- **Frontend**: React, Zustand, TanStack, Tailwind
4138
- **Backend**: Node, Express, MongoDB
42-
- **Integrations**: Google Calendar API, Google OAuth2
4339
- **Testing**: Bun, React Testing Library, Playwright
4440

45-
## Getting Started
46-
47-
### Option 1: Try Compass Online
48-
49-
[compasscalendar.com](https://www.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme) ← No signup required.
50-
51-
### Option 2: Run Compass Locally
52-
53-
```bash
54-
# Quick start
55-
bun install
56-
cp compass.example.yaml compass.yaml # then replace the placeholder values
57-
bun run dev:web # Frontend on http://localhost:9080
58-
bun run dev:backend # Backend on http://localhost:3000
59-
60-
# Testing
61-
bun run test:core && bun run test:web && bun run test:backend
62-
bun run test:e2e
63-
```
64-
65-
### Option 3: Self-host Compass
66-
67-
Run Compass on a server you control to keep everything on your infrastructure.
41+
## Getting started
6842

69-
See [the self-hosting guide](./docs/self-hosting/README.md) for instructions.
43+
| Option | Description | Instructions |
44+
|---|---|---|
45+
| **1. Try Compass web** | Use Compass now (no signup required). | [compasscalendar.com](https://www.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme) |
46+
| **2. Run Compass locally** | Run Compass on your machine. | `bun install`<br><br>`cp compass.example.yaml compass.yaml` <br><br>`bun run dev:web`<br><br>`bun run dev:backend`<br><br>Open [http://localhost:9080](http://localhost:9080). |
47+
| **3. Self-host Compass** | Run Compass on your server. | See [the self-hosting guide](./docs/self-hosting/README.md). |
7048

7149
## Resources
7250

0 commit comments

Comments
 (0)