summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Dolgov <ivan@dolgov.fi>2021-03-22 06:54:10 +0000
committerIvan Dolgov <ivan@dolgov.fi>2021-03-22 06:54:10 +0000
commit57a6799c3c67d916425cb0fc7f95387b937807ed (patch)
treefaf9b80d044afa5cfe3739c3b4852ed87dfdf4e8
parent8c71eeeddbb0099a35c19191a1b807d7f85d4133 (diff)
parentd32bddd7da461212508d05d340369c79938a6ef6 (diff)
downloadpuomi-57a6799c3c67d916425cb0fc7f95387b937807ed.tar.gz
Merge branch 'docs' into 'main'
doc: add a few more words to describe Puomi See merge request larswirzenius/puomi!1
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 486a769..9b30015 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
# README for Puomi
-Puomi will be a Debian-based home router software appliance.
+Puomi will be software for a simple Internet router and access point
+for home and small office use. A device running Puomi connects one or
+more machines via Ethernet and wifi to the Internet, while providing a
+firewall against outside intrusions.
+
+Puomi will be based on the Debian GNU/Linux operating system. It needs
+to be run on a small PC or other suitable hardware. Puomi will have no
+interactive user interface, and will be managed entirely via Ansible.
+
+## Hardware
+
+We will be aiming Puomi at hardware like the following:
+
+- <https://www.qotom.net/product/35.html>
+ A small headless PC with multiple Ethernet ports.
+
+- <https://www.crowdsupply.com/traverse-technologies/ten64>
+ A headless Arm64 box with many networking options.
+
+
+## Related links
+
+- <https://routersecurity.org/consumerrouters.php>
+ Criticisms of consumer routers.