summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLucas Christian <lucas@lucasec.com>2016-07-16 23:04:52 -0700
committerLucas Christian <lucas@lucasec.com>2016-07-16 23:04:52 -0700
commit20861375e78338b67a25b71cf1eba383327c84fc (patch)
tree359f8b18cb127ce9f718106fe04d2ed121b344a8
parent0d5c2237658f8bde9e0f754cb6830d51594b6203 (diff)
downloadmdns-repeater-20861375e78338b67a25b71cf1eba383327c84fc.tar.gz
mdns-repeater-20861375e78338b67a25b71cf1eba383327c84fc.zip
Update README
-rw-r--r--README.md (renamed from README.txt)22
1 files changed, 6 insertions, 16 deletions
diff --git a/README.txt b/README.md
index 639954d..30a0a35 100644
--- a/README.txt
+++ b/README.md
@@ -1,32 +1,22 @@
mdns-repeater
==============
-mdns-repeater is a Multicast DNS repeater for Linux. Multicast DNS uses the
-224.0.0.51 address, which is "administratively scoped" and does not
-leave the subnet.
+mdns-repeater is a Multicast DNS repeater for Linux. Multicast DNS uses the 224.0.0.51 address, which is "administratively scoped" and does not leave the subnet.
-This program re-broadcast mDNS packets from one interface to other interfaces.
-It was written primarily to be run on my Linksys WRT54G which runs dd-wrt,
-since my wireless network is on a different subnet from my wired network and
-I would like my zeroconf devices to work properly across the two subnets.
+mdns-repeater provides a "keep it simple, stupid" solution to discovering mDNS services across subnets, and is primarily intended for router distributions and software firewalls.
-Since the mDNS protocol sends the AA records in the packet itself, the
-repeater does not need to forge the source address. Instead, the source
-address is of the interface that repeats the packet.
+Since the mDNS protocol sends the AA records in the packet itself, the repeater does not need to forge the source address. Instead, the source address is of the interface that repeats the packet.
USAGE
-----
mdns-repeater only requires the interface names and it will do the rest.
-For example, the dd-wrt standard installation defines br0 for the wireless
-interface and vlan1 as the WAN interface, I would use:
+For example, the dd-wrt standard installation defines br0 for the wireless interface and vlan1 as the WAN interface, I would use:
mdns-repeater br0 vlan1
-You can also specify the -f flag for debugging, which prints packets as they
-are received.
+You can also specify the -f flag for debugging, which prints packets as they are received.
-You are free to modify the code to repeat whatever traffic you require, as
-long as you abide by the software license.
+You are free to modify the code to repeat whatever traffic you require, as long as you abide by the software license.
LICENSE