From 7e849feffebbdb3a415442c69678c31824bdca47 Mon Sep 17 00:00:00 2001
From: antanst <antanst@antanst.com>
Date: Tue, 8 Oct 2024 17:28:10 +0300
Subject: [PATCH] Add README.md

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1282424
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# gemini-grc
+
+A Gemini crawler.
+
+## TODO
+- [ ] Save image/* and text/* files
+- [ ] Wide events logging
+- [ ] Handle URLs that need presentation of a TLS cert? Like astrobotany
+  + [ ] Probably have a common "grc" cert for all
+- [ ] Proper input and response validations:
+  + [ ] When making a request, the URI MUST NOT exceed 1024 bytes
+  + [ ] Response headers MUST be UTF-8 encoded text and MUST NOT begin with the Byte Order Mark U+FEFF.
+- [ ] Proper handling of all response codes
+- [ ] Proper validation (or logging) of invalid/expired TLS certs?
+- [ ] Subscribe to gemini pages? gemini://geminiprotocol.net/docs/companion/
+- [ ] Follow robots.txt gemini://geminiprotocol.net/docs/companion/
+
+## TODO later
+- [ ] Add other protocols
+  + [ ] Scroll gemini://auragem.letz.dev/devlog/20240316.gmi
+  + [ ] Spartan
+  + [ ] Nex
+  + [ ] SuperTXT https://supertxt.net/00-intro.html