From 7e409e49da31ec8a3279d9642e8592d669145604 Mon Sep 17 00:00:00 2001
From: Alex <a@tushynski.me>
Date: Thu, 21 Nov 2024 19:03:22 +0000
Subject: [PATCH] Update README.md

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 8b13789..1d13d9d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,33 @@
+This project helps users to convert Documents (.pdf, .png, .jpg, .jpeg) into Markdown for you ease of ingestion into LLM workflows.
 
+It uses a public LLM endpint (doc2md) [here](https://llm.arc53.com/docs#/)
+This endpoint simply gives images or pdfs (converted to images) to visual model and asks it to conver it into markdown.
+
+Here is a quick snippet using python to perform such task:
+```python
+# Client is your OpenAI compatible client
+model = 'meta-llama/Llama-3.2-11B-Vision-Instruct'
+prompt = "Convert the following image to just the markdown text, respond only with text and description of it if relevant."
+messages = [
+    {
+        "role": "user",
+        "content": [
+                    {
+            "type": "text",
+            "text": prompt,
+            },
+            {
+            "type": "image_url",
+            "image_url": {
+                "url":  f"{base64_image}"
+            },
+            },
+        ]
+    }
+]
+response = client.chat.completions.create(model=model,
+    messages=messages,
+    stream=False,
+    max_tokens=int(max_new_tokens),
+    **kwargs)
+```