Skip to content

Commit 72520c9

Browse files
alekseiavgustinalekseiavgustin
authored
Update README.md
1 parent 6110ce2 commit 72520c9

1 file changed

Lines changed: 120 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 120 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,120 @@
1-
# ChronOs
2-
Chronos is a beautiful weekly scheduler built around drag-and-drop functionality. With recurring events, and calendar export. Developed by Aleksei Avgustin.
1+
# Chronos — Weekly Scheduler
2+
3+
Chronos is built around a simple idea: you have a list of things you need to do, and you should be able to drag them straight onto your week and schedule them — no friction, no fuss. Start with your tasks on the right, drag them onto the calendar on the left, and your week plans itself.
4+
5+
A fully offline weekly planner that lives in a single HTML file.
6+
No accounts. No server. No dependencies. Just open and schedule.
7+
8+
**[→ Open Chronos](https://chronos.oneapp.dev)**  ·  [GitHub Pages mirror](https://alekseiavgustin.github.io/chronos)
9+
10+
---
11+
12+
## Features
13+
14+
- **Drag-and-drop scheduling** — drag task cards from the panel onto the calendar grid
15+
- **Draw to create** — click and drag directly on the calendar to draw a new event
16+
- **Recurring events** — weekly or biweekly, on specific days you choose
17+
- **Biweekly W1 / W2 view** — toggle between alternating week groups
18+
- **Resize events** — drag the bottom edge of any event to adjust duration
19+
- **Conflict detection** — red outline when a drop would overlap an existing event
20+
- **Lock & Done** — lock events so they can't be moved; mark events as done
21+
- **Undo / Redo** — full history with Ctrl+Z / Ctrl+Y, up to 40 steps
22+
- **Categories** — 6 built-in colour categories, fully editable, add custom ones
23+
- **Stats tab** — hours by category, hours by day, daily target progress bar
24+
- **Outline tab** — chronological text view of the week, click to scroll the calendar
25+
- **Save / Load** — produces a portable base64 code; paste it back on any device to restore
26+
- **Apple Calendar export** — `.ics` export with configurable date range (4 weeks → 1 year)
27+
- **PDF / Print** — opens a clean, print-ready pop-up of the current week
28+
- **Bulk import** — paste a comma-separated task list; live preview before committing
29+
- **AI integration** — built-in prompt and schedule-sharing tab for use with Claude or any LLM
30+
- **Draggable divider** — resize the calendar / task panel split to your liking
31+
- **Fully offline** — the entire app is one `.html` file; no data leaves your browser
32+
33+
---
34+
35+
## Usage
36+
37+
**Online:** visit the link above — nothing to install.
38+
39+
**Offline / self-hosted:**
40+
```
41+
1. Download index.html
42+
2. Open it in any modern browser
43+
3. That's it
44+
```
45+
46+
---
47+
48+
## Keyboard Shortcuts
49+
50+
| Key | Action |
51+
|-----|--------|
52+
| `N` | New task |
53+
| `L` | Bulk import |
54+
| `T` | Jump to today |
55+
| `← →` | Previous / next week |
56+
| `1` / `2` | Switch W1 / W2 biweekly view |
57+
| `Ctrl+Z` | Undo |
58+
| `Ctrl+Y` | Redo |
59+
| `?` | Show shortcuts |
60+
| `Dbl-click` event | Edit event |
61+
| `Right-click` event | Context menu |
62+
63+
---
64+
65+
## Bulk Import Format
66+
67+
Click the **⋮** list button (or press `L`) and paste tasks in this format:
68+
69+
```
70+
Name, duration, category, repeat, days
71+
```
72+
73+
Examples:
74+
```
75+
Morning run, 45m, Health, weekly, Mon Wed Fri
76+
Deep work, 2h, Work
77+
Team sync, 30m, Work, biweekly, Mon Wed
78+
Read, 1h 30m, Learning, weekly, Mon Tue Wed Thu Fri
79+
```
80+
81+
- **Duration:** `45m` · `2h` · `1h 30m` · `90` (bare number = minutes)
82+
- **Category:** Work · Personal · Health · Social · Learning · Other · or any custom name
83+
- **Repeat:** `weekly` or `biweekly` followed by day names
84+
85+
---
86+
87+
## Save Format
88+
89+
The **💾 Save** button produces a Base64-encoded JSON blob. Paste it into **📂 Load** on any device to restore your full schedule including categories, events, tasks, and settings. Nothing is stored server-side — the code is entirely self-contained.
90+
91+
---
92+
93+
## Telegram Bot
94+
95+
A companion bot — **[@chronos_1bot](https://t.me/chronos_1bot)** — lets you paste a Chronos save code into Telegram and receive reminders before your events. See [`chronos_bot.py`](chronos_bot.py) and [`SETUP.md`](SETUP.md) to self-host your own instance.
96+
97+
---
98+
99+
## Tech Stack
100+
101+
| Layer | Choice |
102+
|-------|--------|
103+
| UI | Vanilla HTML + CSS + JavaScript — zero frameworks |
104+
| Fonts | Instrument Serif · JetBrains Mono · DM Sans (Google Fonts) |
105+
| Storage | None — all state is in-memory; export is manual |
106+
| Build | None — single file, open directly |
107+
108+
---
109+
110+
## License
111+
112+
MIT — see [LICENSE](LICENSE).
113+
Free to use, modify, and self-host. Attribution appreciated.
114+
115+
---
116+
117+
## Author
118+
119+
**Aleksei Avgustin** — [Alekseiavgustin25@gmail.com](mailto:Alekseiavgustin25@gmail.com)
120+
Built with the assistance of Claude AI by Anthropic.

0 commit comments

Comments
 (0)