From 77d25642b533a75177f9366e51581aa67225ea39 Mon Sep 17 00:00:00 2001
From: Malte Tashiro <malte@iij.ad.jp>
Date: Wed, 20 Dec 2023 04:05:54 +0000
Subject: [PATCH] Add README for IANA crawler

---
 iyp/crawlers/iana/README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 iyp/crawlers/iana/README.md

diff --git a/iyp/crawlers/iana/README.md b/iyp/crawlers/iana/README.md
new file mode 100644
index 0000000..dec1602
--- /dev/null
+++ b/iyp/crawlers/iana/README.md
@@ -0,0 +1,25 @@
+# IANA -- https://www.iana.org/
+
+The Internet Assigned Numbers Authority (IANA) is responsible for the global
+coordination of the DNS Root, IP addressing, and other Internet protocol resources.
+
+Datasets used by IYP:
+
+- DNS [root zone file](https://www.iana.org/domains/root/files) to retrieve information
+  about authoritative name servers of the top-level domains as well as their IP
+  addresses.
+
+## Graph representation
+
+### Root zone file -  `root_zone.py`
+
+IYP imports `NS`, `A`, and `AAAA` records from the root zone file.
+
+```Cypher
+// NS record
+(:DomainName {name: 'jp'})-[:MANAGED_BY]->(:DomainName:AuthoritativeNameServer {name: 'a.dns.jp'})
+// A record
+(:DomainName:AuthoritativeNameServer {name: 'a.dns.jp'})-[:RESOLVES_TO]->(:IP {ip: '203.119.1.1'})
+// AAAA record
+(:DomainName:AuthoritativeNameServer {name: 'a.dns.jp'})-[:RESOLVES_TO]->(:IP {ip: '2001:dc4::1'})
+```