bavitutor 0.3.0 → 0.3.2

package/README.md

@@ -83,12 +83,38 @@ vpx /path/to/bavitutor --no-open        # vpx takes the same specs and flags
 | `--host <host>`    | `127.0.0.1`        | interface to listen on (this machine only) |
 | `--data-dir <dir>` | `~/.bavitutor`     | database, plus settings in `<dir>/.env`    |
 | `--no-open`        |                    | don't open the browser                     |
+| `--tailscale`      |                    | also share it on your tailnet (see below)  |
 
 On start the CLI checks for a Claude login or `ANTHROPIC_API_KEY`, looks for
 Chrome (`BAVI_CHROME`, then the standard Windows, macOS and Linux locations)
 and warns if either is missing, and stops with a clear message if the port is
 taken.
 
+### Open it on your other devices
+
+```sh
+npx bavitutor --tailscale
+```
+
+With `--tailscale`, BaviTutor also shares itself on your
+[Tailscale](https://tailscale.com) tailnet, so your phone or another computer
+can open it:
+
+```text
+BaviTutor is running at http://localhost:4100  (Ctrl+C to stop)
+     on your tailnet at https://laptop.tail1234.ts.net:4100
+```
+
+It runs `tailscale serve` over HTTPS on the same port number, so anything you
+already serve on 443 stays as it is. Only devices on your tailnet can reach it
+(it is not Funnel), and the share stops when BaviTutor stops. Anyone on your
+tailnet can use it, on your Claude login.
+
+It needs Tailscale installed and logged in, with MagicDNS and HTTPS
+Certificates turned on (admin console, DNS page). If something is missing,
+BaviTutor says what to fix and still runs on this computer. If BaviTutor is
+already running, `--tailscale` shares that one until you press Ctrl+C.
+
 ### Configuration (environment, `apps/server/.env` in dev, `<data-dir>/.env` for the CLI)
 
 | Variable               | Default             | Meaning                                                    |
@@ -135,10 +161,16 @@ The three `BAVI_MODEL_*` variables are only starting points: **Settings → AI m
    Reviews interleave subjects, pick the question level from memory strength
    (one lower after a lapse, discrimination items against confusable
    concepts), compress overlapping concepts into fewer items, and give
-   implicit credit to prerequisites. A hint ladder caps how much a helped
-   answer counts. Concepts that keep slipping get flagged with remediation;
-   a backlog switches to triaged catch-up spread over a week; after a long
-   absence a 5-minute check-in replaces the pile. "Just 5" keeps it short.
+   implicit credit to prerequisites. You never rate yourself: "I don't know"
+   is the honest no, and each rating comes from whether you were right, how
+   long you took against your usual time, and any hints. A hint ladder caps
+   how much a helped answer counts. Anything you miss or struggle with comes
+   back later in the session, as a new question, until you get it right
+   without a struggle. A session ends by naming the concepts that were
+   strong and the ones that need practice. Concepts that keep slipping get
+   flagged with remediation; a backlog switches to triaged catch-up spread
+   over a week; after a long absence a 5-minute check-in replaces the pile.
+   "Just 5" keeps it short.
    Every concept is also split into a few **ideas**, each with its own FSRS
    card: a flashcard round closes each lesson, and due ideas come back as
    flashcards written fresh each time from how they were asked before. You
@@ -153,8 +185,8 @@ The three `BAVI_MODEL_*` variables are only starting points: **Settings → AI m
    time, retention, new-concept cap, visuals, a daily reminder, and the
    Claude model, reasoning level and fast mode for each kind of work. A goal
    can have an exam date that tightens scheduling. Progress shows durable
-   knowledge, predicted and measured retention, calibration, activity and a
-   review forecast. Lessons resume after a reload, and a break is suggested
+   knowledge, predicted and measured retention, activity and a review
+   forecast. Lessons resume after a reload, and a break is suggested
    after about 25 minutes.
 
 ### Learning from your own sources