You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: puffin_http/README.md
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,3 +8,16 @@
8
8
A HTTP server/client for communicating [`puffin`](https://github.com/EmbarkStudios/puffin) profiling events.
9
9
10
10
You can view them using [`puffin_viewer`](https://github.com/EmbarkStudios/puffin/tree/main/puffin_viewer).
11
+
12
+
## How to use
13
+
Add a `puffin_http``Server` to the profiled application
14
+
When the server is started, [`puffin_viewer`](https://crates.io/crates/puffin_viewer) application can connect to it and display profiling informations.
Copy file name to clipboardExpand all lines: puffin_http/src/lib.rs
+9Lines changed: 9 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,13 @@
1
1
//! `puffin_server` is a library for streaming `puffin` profiler data over TCP.
2
+
//!
3
+
//! # How to use
4
+
//! Add a `puffin_http` `Server` to the profiled application.
5
+
//! When the server is started, [`puffin_viewer`](https://crates.io/crates/puffin_viewer) application can connect to it and display profiling informations.
6
+
//!
7
+
//! ```
8
+
//! let server_addr = format!("0.0.0.0:{}", puffin_http::DEFAULT_PORT);
0 commit comments