readme

README.md

@@ -0,0 +1,19 @@
+# wrap-real-ip
+
+Warp filter to get the "real ip" of the remote client
+
+This uses the "x-forwarded-for" or "x-real-ip" headers set by reverse proxies.
+To stop clients from abusing these headers, only headers set by trusted remotes will be accepted.
+
+## Example
+
+```rust
+use warp::Filter;
+use warp_real_ip::real_ip;
+use std::net::IpAddr;
+
+let proxy_addr = [127, 10, 0, 1].into();
+warp::any()
+    .and(real_ip(vec![proxy_addr]))
+    .map(|addr: Option<IpAddr>| format!("Hello {}", addr.unwrap()));
+```

src/lib.rs

@@ -7,6 +7,19 @@ use warp::Filter;
 ///
 /// This uses the "x-forwarded-for" or "x-real-ip" headers set by reverse proxies.
 /// To stop clients from abusing these headers, only headers set by trusted remotes will be accepted.
+///
+/// ## Example
+///
+/// ```no_run
+/// use warp::Filter;
+/// use warp_real_ip::real_ip;
+/// use std::net::IpAddr;
+///
+/// let proxy_addr = [127, 10, 0, 1].into();
+/// warp::any()
+///     .and(real_ip(vec![proxy_addr]))
+///     .map(|addr: Option<IpAddr>| format!("Hello {}", addr.unwrap()));
+/// ```
 pub fn real_ip(
     trusted_proxies: Vec<IpAddr>,
 ) -> impl Filter<Extract = (Option<IpAddr>,), Error = Infallible> + Clone {