From adc56015890eccbc1630805c0eaf179946cc4af0 Mon Sep 17 00:00:00 2001 From: Pranav Jerry Date: Sun, 6 Jun 2021 17:49:56 +0530 Subject: [PATCH] updated README.md Updated the inroduction and added a bit more on how it works. --- README.md | 44 +++++++++++++++++++++++--------------------- naxalnet | 17 ++++++++++++++++- 2 files changed, 39 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index b40d69a..e51331e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,27 @@ # naxalnet -Naxalnet is an experiment to create an intranet and use it for -communicating with each other during an internet shutdown. It tries to use +**naxalnet** is an experiment to create a wireless mesh network for +communicating with each other during an internet shutdown, using existing software and tech as much as possible. Currently -you can only communicate with other peers running the same software. +you can only communicate with other peers running naxalnet or +using the same network as naxalnet. It uses +[B.A.T.M.A.N. Advanced](https://www.open-mesh.org/projects/batman-adv/wiki), +an implementation of the B.A.T.M.A.N. routing protocol to +communicate with peers. The name naxal comes from Naxalbari, a village in Darjeeling, West Bengal. -A rewrite in python is in progress in the branch python-rewrite. +This is the ongoing python rewrite branch, which uses +[dasbus](https://github.com/rhinstaller/dasbus) to communicate +with iwd.