kryptheon 0.1.3 → 0.1.4

package/README.md

@@ -1,36 +1,39 @@
 # kryptheon
 
-Record what you do in your app, and get told in plain English when it breaks.
+Record a flow in your app once, replay it after every AI change, and get told in
+plain English what broke.
 
-No test code to write, no config to edit.
+Runs entirely on your machine. No account, no API key, nothing leaves your
+computer. It is a wrapper around [Playwright](https://playwright.dev).
 
-## Use it
+Made by a 17-year-old vibecoder who kept having AI break things in his own app.
 
-Install it into your project first:
+## Install
 
 ```
 npm i -D kryptheon
 ```
 
-This step is not optional. Every recording kryptheon writes starts with
-`import { test, expect } from 'kryptheon/kryptheon-fixture'`, and your tests can
-only find that import if kryptheon lives in your project's `node_modules`.
-Running `npx kryptheon` without installing will record fine but fail to check.
+Install it into your project, not globally — every recording imports
+`kryptheon/kryptheon-fixture`, and your tests can only find that if kryptheon is
+in your project's `node_modules`.
 
-Then record:
+## Record
 
 ```
 npx kryptheon record https://your-app.example.com
 ```
 
-A browser opens. Use your app the way a customer would — click, type, sign in.
-Close the browser when you are done, and the recording is saved as a test.
+A browser opens. Use your app the way a customer would. Close the browser when
+you are done, and the recording is saved as a test.
+
+## Check
 
 ```
 npx kryptheon check
 ```
 
-Runs everything you have recorded and reports what happened:
+Runs everything you have recorded:
 
 ```
 OK  Sign in  (4.1s)
@@ -45,15 +48,28 @@ X  Checkout
        the server crashed or is unavailable - the error is in backend code, not the page
 ```
 
-Every failure also ends with a short summary you can paste straight into an AI
-coding tool.
+Every failure ends with a short summary you can paste straight into an AI coding
+tool.
+
+## Recording something that replays
+
+A recording is only useful if it still works the second time. So:
+
+- **Record one simple flow.** Sign in and look at a page. Open a thing and check
+  it loaded. Short beats thorough.
+- **Sign in with an account that already exists.** Do not sign up during a
+  recording — the account exists next time, and the signup step fails.
+- **Avoid steps that cannot repeat.** Adding data piles up a row on every run.
+  Logging out at the end means the next run does not start where this one did.
+
+Kryptheon warns you about these after a recording, and names the exact step.
 
 ## Automatic checks
 
-The first time a test passes, kryptheon remembers where the browser ended up
-and what the page was called. If either changes later, the test fails and tells
-you what changed — so a recording catches regressions without you writing a
-single assertion.
+The first time a test passes, kryptheon remembers where the browser ended up and
+what the page was called. If either changes later, the test fails and says what
+changed — so a recording catches regressions without you writing a single
+assertion.
 
 When a change is intentional, accept it for that one test:
 
@@ -71,15 +87,18 @@ npx kryptheon accept "Checkout"
 | `kryptheon-baselines.json` | the remembered result for each test |
 | `kryptheon-history.jsonl` | one line per run, used for "this was working on …" |
 
-`.env` in the same folder is loaded automatically, so a recording can sign in
-without the password living in the test file.
+A `.env` in the same folder is loaded automatically, and anything you type into a
+password box is replaced with an environment variable rather than written into
+the test.
 
 Worth adding to `.gitignore`: `.env`, `kryptheon-baselines.json`,
 `kryptheon-history.jsonl`, `test-results/`.
 
 ## Requirements
 
-Node 20.6 or later. The first run downloads a browser (about 200MB, once).
+Node 20.6 or later. Recording needs a real terminal window — it opens a browser,
+so it cannot run inside an AI coding assistant. The first run downloads a browser
+(about 200MB, once).
 
 ## Licence
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kryptheon",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Record what you do in your app and get plain-language reports when it breaks.",
   "license": "MIT",
   "type": "commonjs",
@@ -36,5 +36,13 @@
     "testing",
     "end-to-end",
     "cli"
-  ]
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jhashantanu987-beep/kryptheon-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jhashantanu987-beep/kryptheon-cli/issues"
+  },
+  "homepage": "https://github.com/jhashantanu987-beep/kryptheon-cli#readme"
 }