aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYotam Nachum <me@yotam.net>2019-10-26 13:51:45 +0300
committerYotam Nachum <me@yotam.net>2019-10-26 13:51:45 +0300
commitcbabb737e624cf191e5425f0ff60cc2051b003d7 (patch)
treee69ee65bf729077cc6487c780c2feb906d13e538
parentAdd example server (diff)
downloadgo-gemini-cbabb737e624cf191e5425f0ff60cc2051b003d7.tar.gz
go-gemini-cbabb737e624cf191e5425f0ff60cc2051b003d7.zip
Add a README with an explanation about the project
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a3db3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+Go Gemini Library
+=================
+
+go-gemini is a library that provide an easy interface to create client and
+servers that speak the Gemini protocol. The library is currently based on
+version 0.9.2 of the spec but will be updated accordingly to new changes in the
+protocol.
+
+
+Example Server
+--------------
+
+The repository comes with an example server that respond with an hardcoded text
+to the root page. To build the server run the following command:
+
+ make build