init

1 files changed, 30 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a909cc9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# laika
+
+async Gemini protocol server.
+
+* Serves static content
+* Configurable gemini root, port, ip to bind to, logfile location.
+
+### To do
+
+* User directories (`~/public_gemini`)
+* Optional autogenerated directory indexes
+* Service files
+* Tests
+
+### Development
+
+The repository is available 
+I'm primarily using [sr.ht/~gbmor/laika](https://sr.ht/~gbmor/laika) for development,
+but the repository will be available at [github.com/gbmor/laika](https://github.com/gbmor/laika).
+
+### Notes
+
+* Gemini project homepage: [https://gemini.circumlunar.space/](https://gemini.circumlunar.space/)
+* Spec: [https://gemini.circumlunar.space/docs/specification.html](https://gemini.circumlunar.space/docs/specification.html)
+
+### What's the name mean?
+
+Gemini the protocol is named after NASA's Project Gemini.
+As a result, some gemini-related projects use space-themed names.
+Laika was the first dog in space.