@shaankhosla/repeater 0.0.26 → 0.1.1

package/CHANGELOG.md

@@ -1,28 +1,10 @@
-## [0.0.26] - 2026-01-09
-
-### 🚀 Features
-
-- Autogenerate Clozes with LLMs (#28)
-- Utilize ansci defined colors rather than custom colors for TUI theme (#44)
+## [0.1.1] - 2026-01-19
 
 ### 🐛 Bug Fixes
 
-- Update naming from repeat to repeater in LLM module (#46)
-- Control characters cause panic in openai headers (#48)
-
-### 💼 Other
-
-- *(deps)* Bump rsa from 0.9.9 to 0.9.10 (#41)
-- Rename repeat->repeater
-- *(deps)* Bump lru from 0.16.2 to 0.16.3 (#43)
+- Make AI wording clearer (#74)
+- Launch drill with background process (#76)
 
 ### 🚜 Refactor
 
-- Change keys used in drill (#42)
-
-### 📚 Documentation
-
-- Make brew install cleaner
-- Alias for install
-- Add github icon
-- Minor rewrite
+- Switch to using auth.json to store keys (#77)

package/README.md

@@ -18,46 +18,30 @@
 `repeater` is a command-line flashcard program that uses [spaced repetition](https://en.wikipedia.org/wiki/Spaced_repetition) to boost your memory retention. It’s like a lightweight, text-based Anki you run in your terminal. Your decks are kept in Markdown, progress is tracked in SQLite, and reviews are scheduled with Free Spaced Repetition Scheduler (FSRS), a state-of-the-art algorithm targeting 90% recall.
 
 
+> *"Just tested this out and it's amazing! The ability to simply use the same file to take your notes (e.g., in class) and as your flashcards source file is a serious game-changer. I love how minimalist it is, too."*  
+> — Reddit user
+
 <img src="check_example.png" alt="Checking card progress" />
 
 > [!NOTE]
 > You can find the main documentation, including installation guides, at [https://shaankhosla.github.io/repeater/](https://shaankhosla.github.io/repeater/).
 
-## Features
-
-- **Markdown-first decks**: write basic Q/A + cloze cards in plain `.md` alongside your notes.
-- **Stable card identity**: “meaning-only” hashing; formatting tweaks don’t reset progress.
-- **FSRS scheduling**: automatic reviews targeting ~90% recall (simple Pass/Fail).
-- **Terminal workflow**: drill TUI, capture editor, and progress dashboard (`drill`, `create`, `check`).
-- **Media + migration**: open linked images/audio/video; import Anki `.apkg` to Markdown.
-- **Optional LLM helper**: add an OpenAI key once and missing Cloze brackets are auto-suggested before drills.
+## How is this different than Anki?
 
+[Anki](https://apps.ankiweb.net) is a powerful and flexible spaced-repetition system with a mature GUI, mobile apps, and a large plugin ecosystem. If you want a highly customizable study system, Anki is an excellent choice.
 
-## Installation
+`repeater` takes a different approach. Instead of asking you to move your active-recall material into a separate application, your notes themselves are the source of truth. Flashcards live directly inside plain Markdown files, alongside regular notes, and are detected automatically. There is no card editor, no syncing layer, and no separate “collection” to manage.
 
-### Install script (Linux & macOS) - Recommended
+In practice, this means less flexibility but much less friction. You edit cards the same way you edit notes, using the same tools, and can easily inspect, version, or refactor your material without exports or migrations. The goal is not to replace Anki’s ecosystem, but to offer a simpler, text-first workflow for people who prefer minimalism, the terminal, and plain files over feature depth.
 
-```
-curl --proto '=https' --tlsv1.2 -LsSf https://github.com/shaankhosla/repeater/releases/latest/download/repeater-installer.sh | sh
-```
-
-### Homebrew (macOS)
-
-```
-brew install shaankhosla/tap/repeater
-```
-
-### Windows (PowerShell)
-
-```
-irm https://github.com/shaankhosla/repeater/releases/latest/download/repeater-installer.ps1 | iex
-```
+## Features
 
-### npm 
+- **Markdown-first decks**: write basic Q/A + cloze cards in plain `.md` alongside your notes.
+- **Media support**: open linked images/audio/video.
+- **Anki import**: import your existing Anki decks `.apkg` to Markdown.
+- **Stable card identity**: “meaning-only” hashing; formatting tweaks don’t reset progress.
+- **Optional LLM helper**: add an OpenAI key once to auto-suggest missing Cloze brackets and optionally rephrase basic questions (see the [docs](https://shaankhosla.github.io/repeater/llm-usage.html)).
 
-```
-npm install @shaankhosla/repeater
-```
 
 ## Quick Start
 
@@ -85,8 +69,36 @@ npm install @shaankhosla/repeater
    repeater drill cards
    ```
 
-   - `Space`/`Enter`: reveal the answer or cloze.
-   - `O`: open the first media file (image/audio/video) referenced in the current card before revealing the answer.
-   - `F`: mark as `Fail`, `Space`/`Enter`: mark as `Pass`.
-   - `Esc` or `Ctrl+C`: end the session early (progress so far is saved).
 
+That's it! `repeater` will automatically track progress and schedule reviews.
+
+
+## Installation
+
+### Install script (Linux & macOS) - Recommended
+
+```
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/shaankhosla/repeater/releases/latest/download/repeater-installer.sh | sh
+```
+
+### Homebrew (macOS)
+
+```
+brew install shaankhosla/tap/repeater
+```
+
+### Windows (PowerShell)
+
+```
+irm https://github.com/shaankhosla/repeater/releases/latest/download/repeater-installer.ps1 | iex
+```
+
+### npm 
+
+```
+npm install @shaankhosla/repeater
+```
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=shaankhosla/repeater&type=date&legend=top-left)](https://www.star-history.com/#shaankhosla/repeater&type=date&legend=top-left)

package/npm-shrinkwrap.json

@@ -22,7 +22,7 @@
       },
       "hasInstallScript": true,
       "name": "@shaankhosla/repeater",
-      "version": "0.0.26"
+      "version": "0.1.1"
     },
     "node_modules/@isaacs/balanced-match": {
       "engines": {
@@ -514,5 +514,5 @@
     }
   },
   "requires": true,
-  "version": "0.0.26"
+  "version": "0.1.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
-  "artifactDownloadUrl": "https://github.com/shaankhosla/repeater/releases/download/v0.0.26",
-  "author": "shaankhosla",
+  "artifactDownloadUrl": "https://github.com/shaankhosla/repeater/releases/download/v0.1.1",
+  "author": "Shaan Khosla <shaan.khosla@proton.me>",
   "bin": {
     "repeater": "run-repeater.js"
   },
@@ -83,7 +83,7 @@
       "zipExt": ".tar.xz"
     }
   },
-  "version": "0.0.26",
+  "version": "0.1.1",
   "volta": {
     "node": "18.14.1",
     "npm": "9.5.0"