diff --git a/docs/index.html b/docs/index.html index 870b250..81cbbbd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -307,7 +307,7 @@
NO API KEY · NO SIGNUP · FREE & OPEN SOURCE

Point it at a merged PR.
Get a plain-English explanation.

Calibrated to whoever's reading — technical or not — plus a short quiz to check it stuck.

-
$ npm install -g pr-explainer
+
$ npm install -g @shilpi1958/pr-explainer
View on GitHub Read the docs @@ -327,7 +327,7 @@

HOW IT WORKS

01
-
Write a short learning-profile.md — your role, what you're trying to understand.
+
Run pr-explainer init once — edit ~/.pr-explainer/learning-profile.md with your role and what you're trying to understand.
02
@@ -348,9 +348,9 @@

HOW IT WORKS

$ pr-explainer https://github.com/acme/billing-service/pull/482
✓ Fetched PR #482 · "Add retry logic to payment webhook handler"
-
✓ Loaded learning-profile.md
+
✓ Loaded ~/.pr-explainer/learning-profile.md
✓ Asking Claude to explain...
-
→ saved to ./explainers/482-retry-logic-for-webhook.md
+
→ saved to ~/.pr-explainer/explainers/01-retry-logic-for-webhook.md
## What changed
Webhook calls to the payment processor now retry 3× with backoff instead of failing silently on timeout.
@@ -388,7 +388,7 @@

Keep track of your own project

WHY NO API KEY

-

Most AI PR-summarizers make you bring your own API key and pay per call. pr-explainer shells out to the Claude Code CLI already on your machine — if you already use it, this is free to try immediately. Nothing new to sign up for.

+

pr-explainer shells out to the Claude Code CLI already on your machine — if you already use it, this is free to try immediately. No separate API key, no signup, nothing new to pay for.

@@ -396,10 +396,11 @@

WHY NO API KEY

INSTALL

# install
-
$ npm install -g pr-explainer
+
$ npm install -g @shilpi1958/pr-explainer
-
# set up your profile
-
$ cp learning-profile.example.md learning-profile.md
+
# set up your profile once (applies everywhere)
+
$ pr-explainer init
+
$ # edit ~/.pr-explainer/learning-profile.md
# explain a PR
$ pr-explainer owner/repo#123