From c0e3bc69d4105c528e363d132ac40a7a9f70c523 Mon Sep 17 00:00:00 2001
From: rmanach <romain.manach@intercloud.com>
Date: Wed, 8 Jan 2025 13:37:28 +0100
Subject: [PATCH] update README

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index dc1d3ea..326a079 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
 # librapi
 
-A simple server to store, search and download resources (books, articles, etc...).
\ No newline at end of file
+A simple server to store, search and download resources (books, articles, etc...).
+Its uses an **sqlite3** database to register resources.
+
+**NOTE**: The UI is dramatically ugly with almost no CSS and no responsiveness with small screens. There's no vocation to build a beautiful UI here, just to demonstrate how easy we can build practicable UI with server side rendering using Go std lib. Ideal for back office.
+
+## Build
+Build the binary `builds/librapi`:
+```bash
+make build
+```
+
+## Run
+```bash
+make run
+```
+You can then access the server through `http://localhost:8585`.
+
+Enjoy !
\ No newline at end of file