From 476cc641e5e613264587c8a447a42a39f8d30504 Mon Sep 17 00:00:00 2001
From: Ondrej Vlach <ondrej@vlach.xyz>
Date: Thu, 18 Jan 2024 21:56:47 +0100
Subject: [PATCH] docs: update README

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b043552..37e6555 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,31 @@
+symfony_example_app
+===================
+
+Generátor QR kódů pro platby z https://topapi.top-test.cz
+
+Quick setup
+-----------
+```bash
+# git clone https://git.nanobyte.cz/nanobyte-public/symfony_example_app.git
+# cd symfony_example_app
+# docker compose run --build php-fpm composer install
+# docker compose up --build
+```
+
+- aplikace je dostupná na http://localhost:8000/
+- na adrese http://localhost:3000/explore je běžící grafana (s loki a tempo)
+- aplikace je nastavená (i na lokálu, běžně bych to nastavil až na devech/stage/PROD) aby posílala logy do lokiho a tracing do tempa pomocí otel protokolu
+
 TODO:
 -----
 - [ ] Chybí speciální slovník nebo vypnutí slovníku pro testy
 - [ ] V reálný aplikaci bych použil Mockery, nicméně tady mě to přijde zbytečný
 - [ ] Nastavení cache ideálně v memcached/redis etc.
-- [ ] Vylepsit OTEL logs
+- [ ] Vyhezkat OTEL logs, OTEL tracing
+- [ ] CI pipelines
+- [ ] k8s deployment
+- [ ] prometheus country na počet requestů/api (počet 200OK/500ERR)
+
+Poznámky
+--------
+- Nejsem kodér (a javascript developer), nevypadá to nijak extra ;-)