added link to internetshutdowns.in in README.md

README.md

@@ -1,8 +1,8 @@
 # naxalnet
 
 **naxalnet** is a program to create a wireless mesh network for
-communicating with each other. It can be useful during an internet
-shutdown, or to join online classes with a group of laptops.
+communicating with each other. It can be useful during an
+[internet shutdown][], or to join online classes with a group of laptops.
 It uses [B.A.T.M.A.N. Advanced][batman-adv], an implementation
 of the B.A.T.M.A.N. routing protocol to communicate with peers.
 
@@ -207,6 +207,7 @@ See [LICENSE](LICENSE) for the complete version of the
 license.
 
 [batman-adv]: https://www.open-mesh.org/projects/batman-adv/wiki
+[internet shutdown]: https://internetshutdowns.in
 [ipfs]: https://ipfs.io "InterPlanetary File System"
 [jami]: https://jami.net "Peer to peer video calls"
 [ssb]: https://scuttlebutt.nz "Secure Scuttlebutt"
@@ -216,7 +217,7 @@ license.
 [arch-resolved]: https://wiki.archlinux.org/title/Systemd-resolved#DNS "systemd-resolved on ArchWiki"
 [batman-systemd]: https://www.open-mesh.org/news/101 "systemd v248 brings support for batman advanced"
 [libremesh]: https://libremesh.org
-[disaster.radio]: https://disaster.radio/
+[disaster.radio]: https://disaster.radio
 [startnx]: #start-naxalnet
 [iwd]: https://iwd.wiki.kernel.org "wifi daemon"
 [free-sw]: https://gnu.org/philosophy/free-sw.html "What is free software?"

naxalnet/scripts.py

@@ -112,6 +112,8 @@ def here_be_dragons():
         print(error)
         sys.exit("Make sure you are root")
 
+    # TODO: implement the daemon here so that it will call setup_devices
+    # every time a device is connected or removed.
     # Now, the iwd part
     try:
         setup_devices(args)
@@ -124,6 +126,7 @@ def here_be_dragons():
 
 
 def parse_args():
+    """parse all arguments and return ArgumentParser.parse_args()"""
     parser = ArgumentParser(
         description="setup batman-adv networks with systemd and iwd"
     )
@@ -145,6 +148,7 @@ def parse_args():
     parser.add_argument(
         "--adhoc-name", "-a", type=str, default=ADHOC_NAME, help="name of adhoc network"
     )
+    # TODO: implement verbose
     parser.add_argument(
         "-v",
         "--verbose",