From 2ca7f8e908a10e3fcbf8d9708b75b9178bcf462c Mon Sep 17 00:00:00 2001
From: Walter Oggioni <oggioni.walter@gmail.com>
Date: Wed, 23 Oct 2024 21:09:11 +0800
Subject: [PATCH] updated README.md

---
 .gitignore |  3 +++
 README.md  | 29 ++++++++++++++++++++---------
 2 files changed, 23 insertions(+), 9 deletions(-)

diff --git a/.gitignore b/.gitignore
index 1c8c959..d6b6d9c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,6 @@
 __pycache__
 *.pyc
 src/bugis/_version.py
+*.egg-info
+/build
+/dist
diff --git a/README.md b/README.md
index 139313d..228dccb 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,23 @@
-# Run
+
+## How to
+
+### Build the docker image
 ```bash
-uwsgi --need-plugin /usr/lib/uwsgi/python_plugin.so \
-      --need-plugin /usr/lib/uwsgi/gevent_plugin.so \
-      -H venv \
-      --http :1180 \ 
-      -w md2html.uwsgi_handler \ 
-      --http-keepalive \
-      --http-auto-chunked \ 
-      --gevent 10
+docker build -t gitea.woggioni.net/woggioni/bugis:latest .
+```
+### Build the pip package
+```bash
+pyproject-build
+```
+
+### Run in docker
+```bash
+docker run --rm -v /your/document/directory:/srv/http  --user $(id -u):$(id -g) -p 127.0.0.1:8000:8000 gitea.woggioni.net/woggioni/bugis:latest
+```
+
+### Run in docker with `nginx` and `plantUML` server
+
+```bash
+docker compose up --build
 ```