Skip to content

Commit 8d64090

Browse files
sovanesyanclaude
andcommitted
Add README with install instructions for macOS and Omarchy
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a947bde commit 8d64090

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Calendarchy
2+
3+
A terminal calendar app that displays Google Calendar and iCloud Calendar events side by side.
4+
5+
## Installation
6+
7+
### macOS (Homebrew)
8+
9+
```bash
10+
brew tap sovanesyan/calendarchy
11+
brew install calendarchy
12+
```
13+
14+
### Omarchy / Linux (from source)
15+
16+
Requires [Rust](https://rustup.rs/).
17+
18+
```bash
19+
git clone https://github.com/sovanesyan/calendarchy.git
20+
cd calendarchy
21+
cargo build --release
22+
sudo cp target/release/calendarchy /usr/local/bin/
23+
```
24+
25+
To add Calendarchy to your application launcher, copy the desktop entry:
26+
27+
```bash
28+
sudo cp calendarchy.desktop /usr/share/applications/
29+
```
30+
31+
## Configuration
32+
33+
Create `~/.config/calendarchy/config.json`:
34+
35+
```json
36+
{
37+
"google": {
38+
"client_id": "YOUR_CLIENT_ID",
39+
"client_secret": "YOUR_CLIENT_SECRET"
40+
},
41+
"icloud": {
42+
"username": "YOUR_APPLE_ID",
43+
"app_password": "YOUR_APP_SPECIFIC_PASSWORD"
44+
}
45+
}
46+
```
47+
48+
Either source can be omitted if you only use one.
49+
50+
## Usage
51+
52+
```bash
53+
calendarchy
54+
```
55+
56+
Navigate with arrow keys. Events from both calendars are displayed in side-by-side panels.

0 commit comments

Comments
 (0)