Skip to content

Commit 0a6778d

Browse files
georgidhristovgeorgidhristov
authored
docs: update README
2 parents 0384f5c + e785aa2 commit 0a6778d

2 files changed

Lines changed: 63 additions & 103 deletions

File tree

‎DebugProbe.AspNetCore/README.md‎

Lines changed: 32 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,23 @@
1-
# DebugProbe.AspNetCore
1+
# DebugProbe.AspNetCore
22

3-
Debug HTTP traffic directly inside your ASP.NET Core pipeline.
3+
DebugProbe.AspNetCore is a lightweight ASP.NET Core debugging tool for inspecting HTTP traffic directly inside your application.
44

5-
[DebugProbe Website](https://debugprobe.dev)
5+
It captures request and response data, exposes a local dashboard, and helps compare traces during API development without requiring a proxy, browser extension, or external SaaS service.
66

7-
---
7+
## Links
88

9-
## Why DebugProbe?
10-
11-
- Inspect requests and responses in real time
12-
- No proxies or external tools
13-
- Built-in request tracing UI
14-
- Compare responses across environments
15-
- Minimal setup for ASP.NET Core applications
16-
17-
---
9+
- Website: [debugprobe.dev](https://debugprobe.dev)
10+
- Documentation: [debugprobe.dev/docs](https://debugprobe.dev/docs)
11+
- Live demo: [demo.debugprobe.dev/debug](https://demo.debugprobe.dev/debug)
12+
- Demo API: [demo.debugprobe.dev/swagger](https://demo.debugprobe.dev/swagger)
13+
- NuGet: [DebugProbe.AspNetCore](https://www.nuget.org/packages/DebugProbe.AspNetCore)
1814

1915
## Install
2016

2117
```bash
2218
dotnet add package DebugProbe.AspNetCore
2319
```
2420

25-
---
26-
2721
## Quick Start
2822

2923
```csharp
@@ -32,14 +26,12 @@ builder.Services.AddDebugProbe();
3226
app.UseDebugProbe();
3327
```
3428

35-
Open:
29+
Start your application and open:
3630

3731
```txt
3832
http://localhost:{port}/debug
3933
```
4034

41-
---
42-
4335
## Optional Configuration
4436

4537
```csharp
@@ -61,56 +53,44 @@ builder.Services.AddDebugProbe(options =>
6153
app.UseDebugProbe();
6254
```
6355

64-
---
65-
6656
## Features
6757

68-
- Request and response inspection
69-
- Headers, query params, and body capture
70-
- Response comparison across environments
71-
- JSON formatting
58+
- Request inspection
59+
- Response inspection
60+
- Headers, query string, and body capture
61+
- Error visibility
62+
- Local debugging dashboard
63+
- Trace comparison across runs or environments
64+
- JSON formatting for captured payloads
7265
- Configurable body capture limits
73-
- Ignore noisy endpoints
66+
- Ignored path configuration for noisy or sensitive endpoints
7467
- Sensitive header masking
75-
76-
---
68+
- Outgoing `HttpClient` request tracing
7769

7870
## Security Defaults
7971

80-
Sensitive headers are automatically masked:
81-
82-
- Authorization
83-
- Cookie
84-
- Set-Cookie
85-
86-
Localhost compare targets are blocked by default.
87-
88-
---
72+
DebugProbe masks common sensitive headers automatically:
8973

90-
## Production Usage
74+
- `Authorization`
75+
- `Cookie`
76+
- `Set-Cookie`
9177

92-
DebugProbe is intended primarily for development environments.
78+
## Intended Usage
9379

94-
If used in production:
80+
DebugProbe is designed primarily for local development and controlled development environments.
9581

96-
- add authentication
97-
- restrict access
98-
- filter sensitive data
82+
If you use it outside local development, protect the dashboard with authentication, restrict network access, and avoid capturing sensitive endpoints or payloads.
9983

100-
---
84+
## Documentation
10185

102-
## Documentation & Demo
86+
For full setup details, screenshots, dashboard behavior, configuration options, and live examples, see the documentation:
10387

104-
Visit the website for:
105-
- latest screenshots
106-
- demos
107-
- guides
108-
- updates
88+
[https://debugprobe.dev/docs](https://debugprobe.dev/docs)
10989

110-
https://debugprobe.dev
90+
## Contributing
11191

112-
---
92+
Contributions are welcome. Please read [CONTRIBUTING.md](https://github.com/DebugProbe/DebugProbe.AspNetCore?tab=contributing-ov-file) before opening an issue or pull request.
11393

11494
## License
11595

116-
Apache License 2.0
96+
DebugProbe.AspNetCore is licensed under the [Apache License 2.0](https://github.com/DebugProbe/DebugProbe.AspNetCore/blob/main/LICENSE).

‎README.md‎

Lines changed: 31 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,23 @@
11
# DebugProbe.AspNetCore
22

3-
Debug HTTP traffic directly inside your ASP.NET Core pipeline.
3+
DebugProbe.AspNetCore is a lightweight ASP.NET Core debugging tool for inspecting HTTP traffic directly inside your application.
44

5-
[DebugProbe Website](https://debugprobe.dev)
5+
It captures request and response data, exposes a local dashboard, and helps compare traces during API development without requiring a proxy, browser extension, or external SaaS service.
66

7-
---
7+
## Links
88

9-
## Why DebugProbe?
10-
11-
- Inspect requests and responses in real time
12-
- No proxies or external tools
13-
- Built-in request tracing UI
14-
- Compare responses across environments
15-
- Minimal setup for ASP.NET Core applications
16-
17-
---
9+
- Website: [debugprobe.dev](https://debugprobe.dev)
10+
- Documentation: [debugprobe.dev/docs](https://debugprobe.dev/docs)
11+
- Live demo: [demo.debugprobe.dev/debug](https://demo.debugprobe.dev/debug)
12+
- Demo API: [demo.debugprobe.dev/swagger](https://demo.debugprobe.dev/swagger)
13+
- NuGet: [DebugProbe.AspNetCore](https://www.nuget.org/packages/DebugProbe.AspNetCore)
1814

1915
## Install
2016

2117
```bash
2218
dotnet add package DebugProbe.AspNetCore
2319
```
2420

25-
---
26-
2721
## Quick Start
2822

2923
```csharp
@@ -32,14 +26,12 @@ builder.Services.AddDebugProbe();
3226
app.UseDebugProbe();
3327
```
3428

35-
Open:
29+
Start your application and open:
3630

3731
```txt
3832
http://localhost:{port}/debug
3933
```
4034

41-
---
42-
4335
## Optional Configuration
4436

4537
```csharp
@@ -61,56 +53,44 @@ builder.Services.AddDebugProbe(options =>
6153
app.UseDebugProbe();
6254
```
6355

64-
---
65-
6656
## Features
6757

68-
- Request and response inspection
69-
- Headers, query params, and body capture
70-
- Response comparison across environments
71-
- JSON formatting
58+
- Request inspection
59+
- Response inspection
60+
- Headers, query string, and body capture
61+
- Error visibility
62+
- Local debugging dashboard
63+
- Trace comparison across runs or environments
64+
- JSON formatting for captured payloads
7265
- Configurable body capture limits
73-
- Ignore noisy endpoints
66+
- Ignored path configuration for noisy or sensitive endpoints
7467
- Sensitive header masking
75-
76-
---
68+
- Outgoing `HttpClient` request tracing
7769

7870
## Security Defaults
7971

80-
Sensitive headers are automatically masked:
81-
82-
- Authorization
83-
- Cookie
84-
- Set-Cookie
85-
86-
Localhost compare targets are blocked by default.
87-
88-
---
72+
DebugProbe masks common sensitive headers automatically:
8973

90-
## Production Usage
74+
- `Authorization`
75+
- `Cookie`
76+
- `Set-Cookie`
9177

92-
DebugProbe is intended primarily for development environments.
78+
## Intended Usage
9379

94-
If used in production:
80+
DebugProbe is designed primarily for local development and controlled development environments.
9581

96-
- add authentication
97-
- restrict access
98-
- filter sensitive data
82+
If you use it outside local development, protect the dashboard with authentication, restrict network access, and avoid capturing sensitive endpoints or payloads.
9983

100-
---
84+
## Documentation
10185

102-
## Documentation & Demo
86+
For full setup details, screenshots, dashboard behavior, configuration options, and live examples, see the documentation:
10387

104-
Visit the website for:
105-
- latest screenshots
106-
- demos
107-
- guides
108-
- updates
88+
[https://debugprobe.dev/docs](https://debugprobe.dev/docs)
10989

110-
https://debugprobe.dev
90+
## Contributing
11191

112-
---
92+
Contributions are welcome. Please read [CONTRIBUTING.md](https://github.com/DebugProbe/DebugProbe.AspNetCore?tab=contributing-ov-file) before opening an issue or pull request.
11393

11494
## License
11595

116-
Apache License 2.0
96+
DebugProbe.AspNetCore is licensed under the [Apache License 2.0](https://github.com/DebugProbe/DebugProbe.AspNetCore/blob/main/LICENSE).

0 commit comments

Comments
 (0)