Add readme files

limanmys · Dec 25, 2023 · 6845a6a · 6845a6a
1 parent 5ba0a5e
commit 6845a6a
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# FastAPI Report Engine
+
+[Jinja2](https://palletsprojects.com/p/jinja/) formatında oluşturulmuş .docx uzantılı rapor şablonları kullanılarak özelleştirilmiş PDF ve CSV rapor almayı sağlayan raporlama servisi.
+
+## Kullanım
+[Link](https://github.com/limanmys/fastapi-report-engine/releases/latest) üzerinden güncel deb paketi, Ubuntu 20.x ve 22.x sistemlere kurularak kullanılmaya başlanabilir. Sistem üzerinde `report-engine.service` servis adıyla ve `8001` portu üzerinden çalışmaktadır.
+
+## Dokümantasyon
+Servis sağlıklı bir şekilde çalışıyorken `<IP_ADDR>:8001/docs` adresi üzerinden Swagger dokümantasyonuna ulaşılabilir.
+
+![swagger.png](./images/swagger.png)
diff --git a/README_EN.md b/README_EN.md
@@ -0,0 +1,11 @@
+# FastAPI Report Engine
+
+Reporting service that allows you to obtain customized PDF and CSV reports using .docx extension report templates created in [Jinja2](https://palletsprojects.com/p/jinja/) format.
+
+## Usage
+You can start using the current deb package by installing it on Ubuntu 20.x and 22.x systems via the [link](https://github.com/limanmys/fastapi-report-engine/releases/latest) . It works on the system under the service name `report-engine.service` and over port `8001`.
+
+## Documentation
+While the service is running properly, Swagger documentation can be accessed at [localhost:8001/docs](localhost:8001/docs).
+
+![swagger.png](./images/swagger.png)