From ba185c070005bb344565b63210ede5b7f59d415e Mon Sep 17 00:00:00 2001 From: Truong Trung Nghia <149591043+ttncode@users.noreply.github.com> Date: Sun, 11 Oct 2026 16:53:02 +0700 Subject: [PATCH] docs: add README with screenshots ## Summary README with what the app does, screenshots, quick start, extension install steps, the default shortcut table, where data lives, and the development commands. ## Testing - Commands match `package.json` scripts and CI. - Relative image links point to files added in this PR. --- README.md | 127 +++++++++++++++++++++++++++++ docs/screenshots/animations.png | Bin 0 -> 77763 bytes docs/screenshots/focus-running.png | Bin 0 -> 55995 bytes docs/screenshots/focus-summary.png | Bin 0 -> 92046 bytes docs/screenshots/shortcuts.png | Bin 0 -> 101883 bytes docs/screenshots/todos.png | Bin 0 -> 100285 bytes 6 files changed, 127 insertions(+) create mode 100644 README.md create mode 100644 docs/screenshots/animations.png create mode 100644 docs/screenshots/focus-running.png create mode 100644 docs/screenshots/focus-summary.png create mode 100644 docs/screenshots/shortcuts.png create mode 100644 docs/screenshots/todos.png diff --git a/README.md b/README.md new file mode 100644 index 0000000..ffa9d0a --- /dev/null +++ b/README.md @@ -0,0 +1,127 @@ +
+
+
|
|
|
+
+## Quick start
+
+Requirements: **Node.js 24 or newer** (see `.nvmrc`) and npm.
+
+```bash
+git clone https://github.com/ttncode/boost-focus-timer.git
+cd boost-focus-timer
+npm ci
+npm run dev
+```
+
+Open
+;v%)a$aM+|j<+S%D?-bMBPEfw-0FROuLhUd7>D(QE8RQJ>
za9u <@Kr@=T7D%q6z8
zI8Ftg%rtoGLX4&|)RzuxsRILvA-ZoqEGJBGo$YV9@=$Q_^779049qM!*W-p8a*7Ec
z!Tpd49GuCN{>r78yPAZ$i_*ef_ayt*t6$+3NE^*zqxJ^`eZ68KYm4&2AYXY}Lz|8M
z3Z>YHk_6{>pEdI*@15G3j--vO S}v8Av*z2dYAvhP^^JL&?gt1;mtHgN_n%-zL-xxtR JIGF;hnwTD1Ipu7nd`H6^n4{}1SVW_CklY3T7
z@&95@5MwJFGsb+iyseClEk!`g2njmTTabxZ87Q&)PBxxE8!}cqWda4xua4z9-|z2mE)>md+;Gq
z(}VSzI+x>!_u{;BC>=04dZPWgq`8Ts@PA5SrW?z2QX-)!QyhzR%t8J0UhgD#NNz@Z
zO``eh*RKE}S}f-Pdlo2@y`azr)~F0zQ*41Ka#Nb{etP{lD<=&P0n;%d=4_>Wq!7p<
zJ