gusmobile

commit f6a2dbda3b60799575948e25b92f008dec05125c
parent 701629005e0ff74e3461d4646481a35bb46bee94
Author: René Wagner <rwa@clttr.info>
Date:   Sun, 27 Aug 2023 15:24:08 +0200

move README to Markdown

Diffstat:
A
README.md
 | 
22
++++++++++++++++++++++
D
README.rst
 | 
10
----------

2 files changed, 22 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# gusmobile
+
+This is a client library for the Gemini protocol. It is intended to provide a
+programming interface that will be familiar to the users of the `requests'
+library, though much simpler.
+
+It is largely extracted from the code of [AV-98](https://tildegit.org/solderpunk/AV-98), the command-line Gemini client by solderpunk, the initiator of the Gemini protocol project.
+
+## requirements
+- Python >= 3.10
+
+## usage
+
+```
+import gusmobile
+
+url = "gemini://geminispace.info"
+
+response = gusmobile.fetch(url)
+print response
+```
+
diff --git a/README.rst b/README.rst
@@ -1,10 +0,0 @@
-gusmobile
-=======
-
-This is a client library for the Gemini protocol. It is intended to provide a
-programming interface that will be familiar to the users of the `requests'
-library, though much simpler.
-
-It is largely extracted from the code of AV-98, the command-line Gemini client
-by solderpunk, the initiator of the Gemini protocol project.
-