Browse files

fix example in readme

  • Loading branch information...
RJ committed Jul 10, 2009
1 parent e492348 commit a2ef9fa697504108e667a945511d4573e899f507
Showing with 9 additions and 5 deletions.
  1. +9 −5 README
@@ -1,13 +1,17 @@
A basic, lightweight c++ wrapper around miniupnp and nat-pmp libraries
-for setting up port fwds, and finding out external IP address.
+for setting up port fwds, detecting max up/downstream bandwidth, and
+finding out external IP address.
-Designed to wrap up miniupnpc/natpmp libs into a static lib with a small API
+Designed to wrap up miniupnpc+natpmp libs into a static lib with a small API
so other projects can easily setup port fwds without shipping extra libs/deps.
+Should detect any upnp or nat-pmp router and automatically use the appropriate
+library under the hood.
Uses cmake to build needed bits of miniupnpc..
@@ -20,7 +24,7 @@ Usage
See the demo in main.cpp, but here's the jist:
Portfwd pf;
- pf.init();
- pf.add("", 1234); // your lan IP, and port to fwd
- pf.remove(1234); // remove port fwding on exit!
+ pf.init(2000); // 2000 = ms to wait for response from router
+ pf.add(1234); // port to fwd to you
+ pf.remove(1234); // remove port fwding on exit

0 comments on commit a2ef9fa

Please sign in to comment.