From 114a22267b3d5b36ddb1908cd96a1703a936e964 Mon Sep 17 00:00:00 2001
From: retoor <retoor@molodetz.nl>
Date: Sun, 24 Nov 2024 16:11:38 +0000
Subject: [PATCH] docs: add project overview, install, build, cli usage, and
 python example to readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a523dd6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Yura LLM Client for Katya server
+
+Part of project with as target replacing the native ollama protocol. This protocol supports streaming and is usable trough https and it is possible to directly attach a web client to the backend.
+
+## Install
+```bash
+pip install -e .
+```
+
+## Build
+```bash
+make build
+``` 
+
+## Command line usage
+```bash
+yura ws://[host]:[port]/[path]/
+```
+
+## Python
+```python
+import asyncio
+from yura.client import AsyncClient
+
+async def communicate():
+    client = AsyncClient("ws://[host]:[port]/[path]/")
+    async for response in client.chat("Your prompt"):
+         print(response)
+
+asyncio.run(communicate())
+```