README and user documentation (en + ja)

[Saber5656]

Title

README and user documentation (en + ja)

Summary

Replace the two-line README with the real English README (install,
quickstart, config reference, privacy/security statement, warning-code
reference) plus a Japanese translation at docs/README.ja.md, and a
starter-config-derived config reference kept in sync by a CI test.

Context

For an OSS security-positioned tool, the README carries the product's
promises (local-only, read-only, redaction-by-default) in user language and
must match the implementation exactly — every claim here is backed by a
DESIGN invariant and its enforcement issue.

Scope

• README.md (English, authoritative), docs/README.ja.md (Japanese,
  content-equal), docs/CONFIG.md (annotated full config), README badge
  wiring for CI.

Detailed Requirements

1. README sections (exact order): logo-free title + one-line description:
   "Generate daily reports and standup summaries from your shell history,
   git commits, and AI agent sessions — no external network I/O (optional
   local LLM via loopback only)." (Do NOT write "fully offline" — the
   loopback LLM is technically network I/O; wording must not exceed
   ADR-002.); Key properties box (I1–I4 in plain words +
   link to docs/INVARIANTS.md); Install (go install …@latest, released
   binaries + checksum verification command); Quickstart (worklog init →
   edit → worklog doctor → worklog daily) with a REAL sample output
   block (taken from the fixture golden — never from a real machine);
   Local LLM setup (Ollama example: ollama pull <model>, config snippet,
   --no-llm note, loopback-only statement); Configuration (top keys table
   • link to docs/CONFIG.md); Report anatomy (annotated sample); Warning
     codes table (from DESIGN §13); Privacy & security (redaction rule ids
     table link, what the LLM receives, what is never sent anywhere, how to
     report vulnerabilities → SECURITY.md); Platform support; Contributing
     (issue plan link, CI gates); License.
2. docs/CONFIG.md: the starter config reproduced with per-key prose
   (default, validation bounds, interaction notes — content derived from
   DESIGN §5, kept in sync manually with a checklist item in the PR
   template? v1: a test asserts config.Starter() appears verbatim inside
   docs/CONFIG.md so drift fails CI).
3. docs/README.ja.md: full Japanese translation (not a summary);
   README.md links to it at the top (日本語版はこちら).
4. Every CLI example in the docs must be executable verbatim against a
   fixture HOME — add a docs-examples test that extracts fenced
   console-tagged blocks from README and runs the worklog … lines
   against the 25 harness asserting exit 0 (drift-proofing the quickstart).
5. Sample outputs use the fixture data (fake tokens visible as
   [REDACTED:github-token] — deliberately showcase redaction in the
   sample).
6. No marketing claims beyond the enforced invariants; wording for
   redaction: "defense in depth, not a guarantee" (ADR-004).

Acceptance Criteria

• README quickstart reproduced verbatim on clean macOS and Linux
  (documented in PR: exact commands from zero → report; CI
  docs-examples test green).
• config.Starter()-in-CONFIG.md sync test green.
• ja/en content parity (section-by-section, human-reviewed; ja is a
  translation, not an abridgment).
• All internal links resolve (docs/INVARIANTS.md, SECURITY.md —
  placeholder link acceptable until 33 lands, noted in PR).
• Warning-code table matches internal/model constants exactly
  (test: reflect over constants, assert each appears in README).
• CI badge renders; no reference to unimplemented features.

Validation

Docs-examples CI test + link checker run (lychee or grep-based relative
link check script) output in PR.

Dependencies

25, 26, 27, 28, 29 (documents the final UX), 30 (docs/INVARIANTS.md must
exist to be linked), 32 (release binaries + checksum instructions must be
real before the README describes them).

Non-goals

Website, screenshots/GIFs (post-v1 polish), CHANGELOG (32), SECURITY.md
content (33), Homebrew instructions (v2).

Design References

• docs/DESIGN.md §12.3, §13, §16
• docs/decisions/ADR-004-redaction-default-on.md,
  ADR-005-licensing-and-distribution.md

---

Source of truth: docs/issues/31-readme-and-user-docs.md (PR #1, branch docs/v1-design). If this issue and the repo docs disagree, the docs win. Execution order and dependencies: docs/ISSUE_PLAN.md (this is issue 31 of 33).