From 99e48b6103210255007ec59a9029006b3f078f56 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, add gitignore

---
 .gitignore               |  2 ++
 .idea/.gitignore         |  8 --------
 .idea/modules.xml        |  8 --------
 .idea/pndpd.iml          |  9 ---------
 .idea/remote-targets.xml | 20 --------------------
 .idea/vcs.xml            |  6 ------
 README.md                | 10 +++++-----
 pndp/process.go          |  2 +-
 pndpd.conf               |  1 +
 9 files changed, 9 insertions(+), 57 deletions(-)
 create mode 100644 .gitignore
 delete mode 100644 .idea/.gitignore
 delete mode 100644 .idea/modules.xml
 delete mode 100644 .idea/pndpd.iml
 delete mode 100644 .idea/remote-targets.xml
 delete mode 100644 .idea/vcs.xml

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4a60582
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+*.iml
+.idea
diff --git a/.idea/.gitignore b/.idea/.gitignore
deleted file mode 100644
index 1c2fda5..0000000
--- a/.idea/.gitignore
+++ /dev/null
@@ -1,8 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
deleted file mode 100644
index ee87094..0000000
--- a/.idea/modules.xml
+++ /dev/null
@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/pndpd.iml" filepath="$PROJECT_DIR$/.idea/pndpd.iml" />
-    </modules>
-  </component>
-</project>
\ No newline at end of file
diff --git a/.idea/pndpd.iml b/.idea/pndpd.iml
deleted file mode 100644
index 338a266..0000000
--- a/.idea/pndpd.iml
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="Go" enabled="true" />
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>
\ No newline at end of file
diff --git a/.idea/remote-targets.xml b/.idea/remote-targets.xml
deleted file mode 100644
index 0a14203..0000000
--- a/.idea/remote-targets.xml
+++ /dev/null
@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="RemoteTargetsManager">
-    <targets>
-      <target name="WSL - Debian" type="wsl" uuid="c04b0bc9-8ac6-47f9-8b32-9b096370586f">
-        <config>
-          <option name="distributionMsId" value="Debian" />
-          <option name="projectRootOnTarget" value="/mnt/c/Users/Main/AppData/Local/JetBrains/Toolbox/apps/Goland/ch-0/213.5744.269/jbr/bin&#10;/pndpd" />
-        </config>
-        <ContributedStateBase type="GoLanguageRuntime">
-          <config>
-            <option name="goPath" value="/home/main/go" />
-            <option name="goRoot" value="/usr/local/go/bin/go" />
-            <option name="goVersion" value="go1.17.5 linux/amd64" />
-          </config>
-        </ContributedStateBase>
-      </target>
-    </targets>
-  </component>
-</project>
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
deleted file mode 100644
index 94a25f7..0000000
--- a/.idea/vcs.xml
+++ /dev/null
@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>
\ No newline at end of file
diff --git a/README.md b/README.md
index d1ff93f..4ea5cee 100644
--- a/README.md
+++ b/README.md
@@ -4,14 +4,14 @@
 - 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
 ```` 
-pndpd config <path to file>")
-pndpd respond <interface> <optional whitelist of CIDRs separated by a semicolon>")
-pndpd proxy <interface1> <interface2> <optional whitelist of CIDRs separated by a semicolon applied to interface2>")
+pndpd config <path to file>
+pndpd respond <interface> <optional whitelist of CIDRs separated by a semicolon>
+pndpd proxy <interface1> <interface2> <optional whitelist of CIDRs separated by a semicolon applied to interface2>
 ````
 More options and additional documentation in the example config file (pndpd.conf).
 
@@ -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.
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