From 5d79d94b009b5fb1dd060ceab6918267a0e1b702 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Te=C3=AFlo=20M?= Date: Wed, 20 Nov 2024 17:21:31 +0100 Subject: [PATCH] update README --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3002362..0df2f17 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ # Raggo - Retrieval Augmented Generation Library -A flexible RAG (Retrieval Augmented Generation) library for Go, designed to make document processing and context-aware AI interactions simple and efficient. +> A flexible RAG (Retrieval Augmented Generation) library for Go, designed to make document processing and context-aware AI interactions simple and efficient. + +

+ 🔍 Smart Document Search • 💬 Context-Aware Responses • 🤖 Intelligent RAG +

+ +[![Go Reference](https://pkg.go.dev/badge/github.com/teilomillet/raggo.svg)](https://pkg.go.dev/github.com/teilomillet/raggo) +[![Go Report Card](https://goreportcard.com/badge/github.com/teilomillet/raggo)](https://goreportcard.com/report/github.com/teilomillet/raggo) +[![License](https://img.shields.io/github/license/teilomillet/raggo)](https://github.com/teilomillet/raggo/blob/main/LICENSE) + ## Quick Start @@ -76,15 +85,7 @@ Environment variables (take precedence over config files): - `RAGGO_COLLECTION`: Collection name - `RAGGO_API_KEY`: Default API key -> A powerful, production-ready RAG (Retrieval-Augmented Generation) library in Go. - -

- 🔍 Smart Document Search • 💬 Context-Aware Responses • 🤖 Intelligent RAG -

-[![Go Reference](https://pkg.go.dev/badge/github.com/teilomillet/raggo.svg)](https://pkg.go.dev/github.com/teilomillet/raggo) -[![Go Report Card](https://goreportcard.com/badge/github.com/teilomillet/raggo)](https://goreportcard.com/report/github.com/teilomillet/raggo) -[![License](https://img.shields.io/github/license/teilomillet/raggo)](https://github.com/teilomillet/raggo/blob/main/LICENSE) ## Table of Contents