Goal
Add a tiny expected-values note under the Environment variable quick reference section in examples/README.md so first-time users know what values to use when they want isolated trace storage or a non-default UI port.
Scope
Keep this docs-only and edit only:
Suggested location: directly below the environment variable quick reference table.
Suggested change
Add one or two short sentences showing practical values, for example:
BROWSERTRACE_HOME=/tmp/browsertrace-demo for an isolated local demo store.
BROWSERTRACE_PORT=4000 when port 3000 is already in use.
Keep the existing Windows PowerShell examples in the troubleshooting sections unchanged unless you only need to reference them.
Acceptance criteria
- The note mentions both
BROWSERTRACE_HOME and BROWSERTRACE_PORT.
- It keeps the wording concise and beginner-friendly.
- It does not change code, examples, or generated assets.
- It does not ask for stars, upvotes, reposts, or promotion.
Verification
Please include the exact commands you ran. For a docs-only change, this is enough:
git diff --check
uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q
If uv is not available in your environment, say that in the PR and run the closest local docs check you can.
Goal
Add a tiny expected-values note under the
Environment variable quick referencesection inexamples/README.mdso first-time users know what values to use when they want isolated trace storage or a non-default UI port.Scope
Keep this docs-only and edit only:
examples/README.mdSuggested location: directly below the environment variable quick reference table.
Suggested change
Add one or two short sentences showing practical values, for example:
BROWSERTRACE_HOME=/tmp/browsertrace-demofor an isolated local demo store.BROWSERTRACE_PORT=4000when port3000is already in use.Keep the existing Windows PowerShell examples in the troubleshooting sections unchanged unless you only need to reference them.
Acceptance criteria
BROWSERTRACE_HOMEandBROWSERTRACE_PORT.Verification
Please include the exact commands you ran. For a docs-only change, this is enough:
If
uvis not available in your environment, say that in the PR and run the closest local docs check you can.