add examples to readme

This commit is contained in:
Izalia Mae 2024-03-20 11:56:00 -04:00
parent 8e00caff4c
commit cfb9eb40ca

View file

@ -2,6 +2,45 @@
Utilities for the Gemini protocol
## Client Example
import asyncio
import gemi
async def main():
client = gemi.AsyncClient()
response = await client.request("geminiprotocol.net")
for element in (await response.document()):
print(repr(element))
asyncio.run(main())
## Server Example
import gemi
@gemi.route("Default", "/")
async def home(request: gemi.Request) -> gemi.Response:
return gemi.Response(20, "UvU", "text/plain")
server = gemi.AsyncServer("Default")
server.run()
## Document Example
import gemi
doc = gemi.Document([
gemi.Header("Hewwo!", 1),
gemi.Text(""),
gemi.Text("im gay"),
gemi.Text(""),
gemi.Link("https://git.barkshark.xyz/barkshark/gemi", "Gemi")
])
doc.dump("/var/lib/gemi-server/static/text.gmi", gemi.OutputFormat.GEMTEXT)
[Documentation](https://docs.barkshark.xyz/gemi)
[Gemini Protocol](https://geminiprotocol.net/)