Permalink
Browse files

Markdownify README

  • Loading branch information...
1 parent c861ca3 commit 1c2d07371ba745d9e2254ed9baf460e8f6157af6 @msantos committed Mar 30, 2012
Showing with 26 additions and 28 deletions.
  1. +0 −28 README
  2. +26 −0 README.md
View
28 README
@@ -1,28 +0,0 @@
-
-Poison the ARPs and spoof them too. farp watches the network for ARP
-packets and replies with the MAC address of the host it is running on.
-This has the effect of sending traffic through your host (if a bridge,
-such as herp, is running) or DoS'ing your network if it is not.
-
-
-EXPORTS
-
-start() -> ok
-start(Device, Options) -> {ok, PID}
-
- Types Device = string()
- Options = [Opts]
- Opts = {gratuitous, Boolean}
- Boolean = true | false
-
- Device is the network interface name.
-
- {gratuitous, true} is the default and will spawn a process to send
- out gratuitous ARP's spoofing your gateway.
-
-
-HOW TO USE IT
-
-> herp:start(). % start up the bridge
-> farp:start().
-
View
26 README.md
@@ -0,0 +1,26 @@
+Poison the ARPs and spoof them too. farp watches the network for ARP
+packets and replies with the MAC address of the host it is running on.
+This has the effect of sending traffic through your host (if a bridge,
+such as herp, is running) or DoS'ing your network if it is not.
+
+
+# EXPORTS
+
+ start() -> ok
+ start(Device, Options) -> {ok, PID}
+
+ Types Device = string()
+ Options = [Opts]
+ Opts = {gratuitous, Boolean}
+ Boolean = true | false
+
+ Device is the network interface name.
+
+ {gratuitous, true} is the default and will spawn a process to send
+ out gratuitous ARP's spoofing your gateway.
+
+
+# HOW TO USE IT
+
+ > herp:start(). % start up the bridge
+ > farp:start().

0 comments on commit 1c2d073

Please sign in to comment.