Skip to content

Commit 5be4646

Browse files
kwschulzclaude
andcommitted
docs: add Quick Start section, fix downloads badge
- Add copy-paste friendly Quick Start right after badges - Use collapsible sections for alternative methods - Switch to shields.io for downloads badge (pepy.tech not rendering) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c4815e7 commit 5be4646

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,44 @@
11
# har-capture
22

33
[![PyPI version](https://badge.fury.io/py/har-capture.svg)](https://pypi.org/project/har-capture/)
4-
[![Downloads](https://pepy.tech/badge/har-capture)](https://pepy.tech/project/har-capture)
4+
[![Downloads](https://img.shields.io/pypi/dm/har-capture)](https://pypi.org/project/har-capture/)
55
[![codecov](https://codecov.io/gh/solentlabs/har-capture/branch/main/graph/badge.svg)](https://codecov.io/gh/solentlabs/har-capture)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77
[![AI Assisted](https://img.shields.io/badge/AI-Claude%20Assisted-5A67D8.svg)](https://claude.ai)
88

99
Capture and sanitize [HAR (HTTP Archive)](http://www.softwareishard.com/blog/har-12-spec/) files for network traffic analysis. HAR files record browser network activity and are commonly used for debugging, diagnostics, and test fixtures.
1010

11+
## Quick Start
12+
13+
```bash
14+
pip install har-capture[full]
15+
har-capture capture --ip 192.168.100.1
16+
```
17+
18+
<details>
19+
<summary><b>Already have a HAR file?</b></summary>
20+
21+
```bash
22+
pip install har-capture
23+
har-capture sanitize myfile.har
24+
```
25+
</details>
26+
27+
<details>
28+
<summary><b>Python API</b></summary>
29+
30+
```python
31+
from har_capture.sanitization import sanitize_har
32+
33+
with open("input.har") as f:
34+
har_data = json.load(f)
35+
36+
sanitized = sanitize_har(har_data)
37+
```
38+
</details>
39+
40+
---
41+
1142
## Why har-capture?
1243

1344
Existing HAR sanitization tools require a **manual, multi-step workflow**:

0 commit comments

Comments
 (0)