From 86bcebadf8ccace8c22875c0fc96fd3ef581fcff Mon Sep 17 00:00:00 2001
From: Quentin BEY
Date: Tue, 26 Aug 2025 15:07:30 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(readme)=20small=20improvements?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
- remove the old handmade logo
- fix the dependencies
- add small introduction
---
README.md | 26 ++++++++++++++++++++------
docs/assets/banner-conversations.png | Bin 1505320 -> 39479 bytes
docs/system-requirements.md | 3 +--
src/backend/pyproject.toml | 2 +-
4 files changed, 22 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index ef679dd..04cb232 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,24 @@
+**Warning:** This project is in active development and in a very early stage. Breaking changes may occur at any time.
+
+
+## Yet another AI chatbot
+
+Conversations is an open-source AI chatbot designed to be simple, secure and privacy-friendly.
+
+Why another AI chatbot? Because we want to be able to fully control our data and the way we interact with AI.
+We want to have a very friendly end-user interface and code, and we want to be able to easily customize the
+chatbot to our needs.
+
+We leverage open-source projects such as [Vercel‘s AI SDK](https://ai-sdk.dev/) and [Pydantic AI](https://ai.pydantic.dev)
+and only assemble them in a way that makes sense for us and allows us to focus on the product.
+
+This assistant's purpose is also to be integrated into the "La Suite numérique" ecosystem of tools for public services.
+
+Any help to improve the project is very welcome!
+
### Self-host
🚀 Conversations is easy to install on your own servers
@@ -32,9 +50,7 @@ You can test Conversations on your browser by visiting this => TBD
### Run Conversations locally
-> ⚠️ The methods described below for running Conversations locally is **for testing purposes only**.
-> It is based on building Conversations using [Minio](https://min.io/) as an S3-compatible storage solution.
-> Of course you can choose any S3-compatible storage solution.
+> ⚠️ The methods described below for running Conversations locally is **for testing purposes only**.
**Prerequisite**
@@ -154,9 +170,7 @@ docs
### Stack
-Conversations is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [Vercel‘s AI SDK](https://ai-sdk.dev/) and [OpenAI Agents SDK](https://github.com/openai/openai-agents-python). We thank the contributors of all these projects for their awesome work!
-
-
+Conversations is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [Vercel‘s AI SDK](https://ai-sdk.dev/) and [Pydantic AI](https://ai.pydantic.dev). We thank the contributors of all these projects for their awesome work!
### Gov ❤️ open source
diff --git a/docs/assets/banner-conversations.png b/docs/assets/banner-conversations.png
index 787f02061f350354d21db68b5d217372195daf22..048c723e2825eb64a6c814a12463d1cc7e9539d1 100644
GIT binary patch
literal 39479
zcmd@419xTH^EM2p!w$P++qP}nwvCQ$+crA3Z71Ea)iFEvv(E3F|NVZ5cV%RZz1LcM
z&RJL0tXWl8MJULL!^2>~fPjF&OG=0+fq;NVfq;CW`3ec#5w2m*0|7zg@l?@pQ8IKR
zaB#9Wv$QcKaPe?3B`|fjGy?%~U+d1WjJ4sk3;DE0)eEGs%1ejnz3-o0)Y^+zaIHI=TXzy0h^m(hC7yBr%i-}#oFvAo%HO-1yvJeO_h7O6|#2-MXu^?&2A#
zm6n*3jLMy_R|<)ZI|lKmn{TvHvW}Q3Io8Y#sjvu9ZLye1ImW=PqATHj-t6S(dX)E(
zo_g$9diF=9D>Hu8n)Nqwi5CmxL5`wdM*{5qG;?tSW_LWsEw(lL1pFURiUWybZq&p=cn&rROi-k^D(+J
z!p0wM*7T~+Pqz-wD|ND
zXL9-f6GZqDVZvjQU0B=$5^_bmHPzmPL9OFv6aAVH!8&q}f;v#ePlUc9+@
zF;?WgGM0{WTQ4)q(z^X;9<<8D)&ER&3YWfG?We{td2(jmn8MmN#*%>ixgQ=%9#O#{
z&L`$4BiWj_g+Iigc!2sA&Y9X@00RPs1XZic4fQNHLxlZ`Ma|&VzU0vnt>4?PyY5QX
z<797un+0Vpgj?2QNV9YAY`K+fiC-FV0_*EOw^cQUN3pT4Fe28T+DGg|N4D@n
ztMb%fh85^@iqhG*?fBxtn>L+$vVW?XByWjr`lAX|E6uo@$cFlR?^5;oks3X$u%m~Y
zledKVCk~(9;iSe36t~
z$;GmMaQf{s;Da#FKfhQM9OxWuo{ye|9Q{?zWx8wP|Ba~;dRDi(ehkrNpM~9c2gP&@
zae#|9ReEb-YS`*ed8c-0%J99+xnh2Ox8_BkEH18virzxSWLlmnC-y?u6&Op5WlE1q2;AX%{Wd~3;oyC**wnb
zzUVbvMT$uCN?i&IArog%2Qs*v#vlXJA7XnrYG#g`(zy0VRB!`g{4BgIjTGN)>DUyY
z;#XUu;jY}$n;5s^De)^9P#=)fzb#Jsi-X-7cP(wwV{X(AXgC=o+q*Jt?>Wl{k;Uim
zrHg6cc!0Rb8n>Fpy1JV+ns;cON^%4_Ju-0MXPD=k@`_HF$lFLB!xu6%&eG_iC;e9NaJzs4)m=W}-g@4^$>Tu9b%P
zee51jWybJ$BQ{=u7+5?m48aZrq-|?#0NqelaKCiENnc`GSD)2R?F4zSCApx>8jUWZ
z$wLXOX_(xVDw{yrOO+_rj+oV}3~PD`r}BdaOlQxqA=DFw^uRS=@@{`;b?{G4*!_WO
zp-|#dkT}q75xv1h5sgzq3wINa*2bKGRH>ruY1qcdY;=x03NqNwfW^M|1DFSG@WjAv
zX$hRp96@W8x@vDmj(3L;X0={H&Nqp&Xqdm4V@K)!s5E$yba2_MJ4vqe>xZKl(*nN)
zgUVEQ8>`GCg9gQ=>DB+}<%r=Ow#KzWA=VE2AM9s>z~oZhp>Zp4v41U(Lpz%sxr%p&
z**CA9>QFecaE$G0(aJ^5ZgLYBZy@~13H=3jz<-;`^U7x#RDf@aJvjQWAoBY03kG)j
z0I|zWHzFQNys=n6D8-R-TMDN^8iY>1Fb={#mO^3Bb#spg)IH=|c%a+P#8cxX<C
zj136AWo#%LI6Y)PB?_dLk%IZCw}c8C-2L6DYEi#?qAOGl->7e3^O2$s>KI>851*3E7UU^iy%W!rLR
z8LxwKslqf+nL1A}R!<6hgLY%q5ACKqVIFq7g8T0KJ1_}O(ag-Tq6HU*ssjn%q?F@f
zFm?u`pAc!h<^H7ZzoT!|xv&ln{0*pn17Ftzy-DljtJ;-^)l+poXFXUbT8BoT#3H0T
zxgW_85Y0xo#^B(9-yEi%3-Ji;ALln@s{rl%5NHXo>!cKCsc)?>$7YIh=_Ct1g8KFI
z3KuglV_=AwLFWxh8GQ*8^1zz8DFlZRaq8RclNrI|z<5x*Usb>oGtnIEVJW=fny5*x
zIwBR^R!Tl3H1`2CHWI$W=)1{=2^2Yl8*y6qz2yX`kwPPd{3>p6k)ox+j77>dPg{P9
zix}MCnxOj~qlhkzQ~yZ4w*vPuJzuEL7Zy^6et!`(0nu56_