Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add some basic usage info

  • Loading branch information...
commit da3be8369202578eb154b6e2129ed324dfaae13d 1 parent 8263baf
@msantos authored
Showing with 21 additions and 1 deletion.
  1. +21 −1 README
View
22 README
@@ -1,3 +1,23 @@
-Erlang layer 2 bridge.
+herp re-writes ethernet headers, thereby acting as a user space bridge.
+Right now, herp works on switched networks and forwards any packets that
+have been sent to the host from ARP spoofing.
+
+In the future, herp will probably become a real, although slow, bridge.
+
+
+EXPORTS
+
+start() -> {ok, PID}
+start(Device) -> {ok, PID}
+
+ Types Device = string()
+
+ Device is the network interface name.
+
+
+HOW TO USE IT
+
+> herp:start(). % start up the bridge
+> farp:start().
Please sign in to comment.
Something went wrong with that request. Please try again.