From f10abbb92a3647a09a92f5be54af58e42309cd51 Mon Sep 17 00:00:00 2001
From: Emmanuel Hugonnet <ehsavoie@users.noreply.github.com>
Date: Wed, 16 Oct 2024 17:29:02 +0200
Subject: [PATCH] Adding build badges (#51)

Signed-off-by: Emmanuel Hugonnet <ehugonne@redhat.com>
Co-authored-by: Yann Blazart <yann.blazart@bycode.fr>
---
 CONTRIBUTING.md          |  2 +-
 README.md => README.adoc | 31 +++++++++++++++++++------------
 2 files changed, 20 insertions(+), 13 deletions(-)
 rename README.md => README.adoc (50%)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 83110a6..c9069c3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -11,7 +11,7 @@ Welcome to the smallrye-llm project! We welcome contributions from the community
 
 ## Contributing Guidelines
 
-Please refer to our Wiki for the https://github.com/smallrye/smallrye/[Contribution Guidelines].
+Please refer to our Wiki for the [Contribution Guidelines](https://github.com/smallrye/smallrye/).
 
 
 ## Issues
diff --git a/README.md b/README.adoc
similarity index 50%
rename from README.md
rename to README.adoc
index 060da27..b407d8f 100644
--- a/README.md
+++ b/README.adoc
@@ -1,41 +1,48 @@
-# 🚀 Smallrye LLM
+:ci: https://github.com/smallrye/smallrye-llm/actions?query=workflow%3A%22SmallRye+Build%22
+
+image:https://github.com/smallrye/smallrye-llm/workflows/SmallRye%20Build/badge.svg?branch=main[link={ci}]
+image:https://img.shields.io/github/license/smallrye/smallrye-llm.svg["License", link="http://www.apache.org/licenses/LICENSE-2.0"]
+image:https://img.shields.io/maven-central/v/io.smallrye.llm/smallrye-llm?color=green["Maven", link="https://central.sonatype.com/search?q=io.smallrye.llm%3Asmallrye-llm-parent"]
+
+= 🚀 Smallrye LLM
 
 Experimentation around LLM and MicroProfile
 
-## How to run examples
+== How to run examples
 
-### Use LM Studio
+=== Use LM Studio
 
-#### Install LM Sutdio
+==== Install LM Studio
 
 https://lmstudio.ai/
 
-#### Download model 
+==== Download model 
 
 Mistral 7B Instruct v0.2
 
-#### Run
+==== Run
 
 On left goto "local server", select the model in dropdown combo on the top, then start server
 
-### Use Ollama
+=== Use Ollama
 
 Running Ollama with the llama3.1 model:
 
-```shell
+[source,bash]
+----
 $CONTAINER_ENGINE= podman | docker
 $CONTAINER_ENGINE run -d --rm --name ollama --replace --pull=always -p 11434:11434 -v ollama:/root/.ollama --stop-signal=SIGKILL docker.io/ollama/ollama
 $CONTAINER_ENGINE exec -it ollama ollama run llama3.1
-```
+----
 
-### Run the examples
+=== Run the examples
 
 Go to each example READEM.md to see how to execute the example.
 
-## Contributing
+== Contributing
 If you want to contribute, please have a look to [CONTRIBUTING.md](CONTRIBUTING.md)
 
-## License
+== License
 
 This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.