From 5e61a08fb67387f8d343293d1a33743d9b0b5259 Mon Sep 17 00:00:00 2001
From: Kioubit <kioubit@localhost.invalid>
Date: Fri, 24 Dec 2021 11:23:39 -0500
Subject: [PATCH] Fix documentation

---
 README.md       | 4 ++--
 pndp/process.go | 2 +-
 pndpd.conf      | 1 +
 3 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index d1ff93f..520882f 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
 - Respond to all NDP solicitations on an interface
 - Respond to NDP solicitations for whitelisted addresses on an interface
 - Proxy NDP between interfaces with an optional whitelist for neighbor solicitations
-- Optionally automatically determine whitelist based on the IPs assigned to the interfaces 
+- Optionally determine whitelist automatically based on the IPs assigned to the interfaces 
 - Permissions required: root or CAP_NET_RAW
 
 ## Usage
@@ -31,4 +31,4 @@ proxyInstance := pndp.NewProxy(iface1 string, iface2 string, filter []*net.IPNet
 proxyInstance.Start()
 proxyInstance.Stop()
 ````
-Pull request are welcome for any functionality you add.
\ No newline at end of file
+Pull requests are welcome for any functionality you add.
\ No newline at end of file
diff --git a/pndp/process.go b/pndp/process.go
index 5078d64..d97a395 100644
--- a/pndp/process.go
+++ b/pndp/process.go
@@ -126,7 +126,7 @@ func (obj *ProxyObj) start() {
 }
 
 //Stop a running Proxy instance
-// Returns false on success
+// Returns false on error
 func (obj *ProxyObj) Stop() bool {
 	close(obj.stopChan)
 	fmt.Println("Shutting down proxy instance..")
diff --git a/pndpd.conf b/pndpd.conf
index c2f5cb6..4d49507 100644
--- a/pndpd.conf
+++ b/pndpd.conf
@@ -30,6 +30,7 @@ responder {
 
 // Proxy example with autoconfigured whitelist
 // The whitelist is configured based on the addresses assigned to the interface specified. This works even if the IP addresses change frequently.
+// The whitelist is applied to iface2
 proxy {
     iface1 eth0
     iface2 eth1