Skip to content

Commit 70544f8

Browse files
authored
Revise README for improved clarity and detail
Updated README to enhance clarity and structure, including new features and quick start instructions.
1 parent 24bfcf0 commit 70544f8

1 file changed

Lines changed: 59 additions & 41 deletions

File tree

README.md

Lines changed: 59 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,33 @@
11
# <img src="./static/chronicle.png" alt="Chronicle icon" width="30" />hronicle
22

33
<p align="center">
4-
<img height="318" alt="chronicle_banner_short" src="https://github.com/user-attachments/assets/110b0df9-f376-403a-95c3-a900ba14550b" />
5-
4+
<img height="318" alt="chronicle_banner_short" src="https://github.com/user-attachments/assets/110b0df9-f376-403a-95c3-a900ba14550b" />
65
</p>
76

8-
Chronicle automatically builds rich Strava activity descriptions by combining data from Strava and your connected stat sources.
7+
<p align="center">Chronicle your activity with automated Strava descriptions.</p>
8+
<p align="center">Chronicle your activity history through heatmaps.</p>
9+
<p align="center">Chronicle your workout sessions and send to garmin.</p>
10+
11+
#
912

10-
## UI Direction
11-
- The MPA is the product and the active refinement target.
12-
- Future styling changes should be reviewed in-browser with `A` vs `B` comparisons at `/design-review`.
13-
- Product direction details: [`docs/UI_DIRECTION.md`](docs/UI_DIRECTION.md)
14-
- Refinement process and page order: [`docs/MPA_REFINEMENT_ROADMAP.md`](docs/MPA_REFINEMENT_ROADMAP.md)
13+
This app is currently built for someone that likes self-hosting their own docker apps, who uses Strava but hates writing out descriptions, and who wears a Garmin watch.
1514

1615
## Key Features
17-
- Auto-processes new activities on a worker heartbeat.
18-
- Writes description templates back to Strava based on activity profile.
19-
- Includes a polished local web app:
16+
- Auto-processes new activities.
17+
- Activity Profile matching,
18+
- yaml Profile Builder.
19+
- Custom Description Templates per profile,
20+
- Jinja Template Builder
21+
- Plan and wargame your next sessions.
22+
- yaml Workout Builder
23+
- Send to your garmin watch workout calendar.
24+
25+
## Includes a polished local web app:
2026
- `View` (`/dashboard`) for long-term trends.
2127
- `Plan` (`/plan`) for planning your next move.
2228
- `Build` (`/editor`) for template editing and preview.
2329
- `Sources` (`/setup`) for source credentials and OAuth.
2430
- `Control` (`/control`) for one-click API operations.
25-
- Supports profile-based templates (for different activity types).
26-
- Exposes local API endpoints for automation and reruns.
2731

2832
## Screenshots
2933
<img width="1915" height="1923" alt="Screenshot 2026-03-07 120436" src="https://github.com/user-attachments/assets/d44ccc82-9439-4a38-b034-c07406f1743e" />
@@ -33,60 +37,74 @@ Chronicle automatically builds rich Strava activity descriptions by combining da
3337
<img width="2336" height="1939" alt="Screenshot 2026-02-20 115752 REDACTED" src="https://github.com/user-attachments/assets/6a4a2e88-c7c0-4692-ac33-5251b52d753d" />
3438

3539

36-
## Quick Start (macOS)
40+
## Quick Start
3741

38-
### Step 0: Install Docker Desktop for Mac
42+
#### Step 0: Install Docker Desktop for Mac
3943
1. Watch this quick setup video: https://www.youtube.com/watch?v=agkOZr27d3Y
4044
2. Install Docker Desktop and launch it.
4145

42-
### Step 1: Open Terminal
46+
#### Step 1: Open Terminal
4347
- Open `Terminal.app`.
4448

45-
### Step 2: Create a folder and clone Chronicle Project
49+
#### Step 2: Create a folder and clone Chronicle Project
4650
```bash
4751
mkdir -p ~/docker/chronicle
4852
cd ~/docker/chronicle
4953
git clone https://github.com/seanap/Chronicle.git
5054
cd Chronicle
5155
cp .env.example .env
5256
```
53-
54-
### Step 3: Start Chronicle
57+
#### Step 3: Start Chronicle
5558
```bash
5659
docker compose up -d --build
5760
```
58-
5961
- Re-run the same command after pulling new code so the latest backend and frontend assets are rebuilt into the image.
6062

61-
### Step 4: Open the app
63+
#### Step 4: Open the app
6264
```bash
6365
http://localhost:1609
6466
```
65-
66-
- Dashboard (`View`): http://localhost:1609/dashboard
67-
- Plan (`Plan`): http://localhost:1609/plan
68-
- Template Editor (`Build`): http://localhost:1609/editor
69-
- Source Setup (`Sources`): http://localhost:1609/setup
70-
- API Control (`Control`): http://localhost:1609/control
71-
- Design review: `http://localhost:1609/design-review`
72-
73-
### Step 5: Add your credentials in `Sources`
67+
#### Step 5: Add your credentials in `Sources`
7468
- Go to `Sources` and fill in your source keys/tokens.
7569
- Source setup guide: [`docs/SOURCES_SETUP.md`](docs/SOURCES_SETUP.md)
7670

71+
## Using Chronicle
72+
73+
#### Auto-Descriptions:
74+
- Go to Build page >
75+
- Template Workshop Drawer >
76+
- Duplicate default Template, save-as, and load >
77+
- Modify Advanced Template jinja >
78+
- Confirm preview then `Save + Publish`
79+
- Profile Workshop >
80+
- Select Profile from dropdown >
81+
- Enable >
82+
- `Set Working`
83+
- Template Workshop >
84+
- Duplicate profile Template, save-as, and load >
85+
- Modify Advanced Template jinja >
86+
- `Save + Publish`
87+
#### Plan
88+
- Go to Plan page
89+
- Pace Workshop drawer >
90+
- Calcule Recent Race >
91+
- Set Marathon Goal
92+
- Type daily mileage targets >
93+
- Set run type to SOS to enable session workout >
94+
- select workout shorthand from dropdown, modify if needed
95+
- Workout Workshop drawer >
96+
- select template from dropdown >
97+
- modify yaml to customize, `Save`
98+
#### View
99+
- Go to View page >
100+
- Scope drawer >
101+
- Enable Years and Activity Types
102+
- Click the top Activity Type buttons to filter
103+
- Click the Data buttons to filter
104+
- Click the bottom Most Active buttons to filter
105+
77106
## Documentation
78107
- API docs: [`docs/API_DOCUMENTATION.md`](docs/API_DOCUMENTATION.md)
79108
- Android widget companion: [`docs/ANDROID_WIDGET_COMPANION.md`](docs/ANDROID_WIDGET_COMPANION.md)
80109
- Android widget APK downloads: [GitHub Releases](https://github.com/seanap/Chronicle/releases)
81110
- Misery Index report: [`docs/MISERY_INDEX_REPORT.md`](docs/MISERY_INDEX_REPORT.md)
82-
83-
## Updating a Docker Deploy
84-
85-
If you already have Chronicle running and want the current MPA product build to show up:
86-
87-
```bash
88-
git pull
89-
docker compose up -d --build
90-
```
91-
92-
Then hard refresh the browser on `/dashboard` or `/control`.

0 commit comments

Comments
 (0)