Update readme files

limanmys · Dec 26, 2023 · 612ea60 · 612ea60
1 parent a72e26e
commit 612ea60
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,17 @@
 # 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.
+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.
 
-## 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.
+## 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`.
 
-## Dokümantasyon
-Servis sağlıklı bir şekilde çalışıyorken `<IP_ADDR>:8001/docs` adresi üzerinden Swagger dokümantasyonuna ulaşılabilir.
+```bash
+sudo apt install ./report-engine-47.deb
+# to show service logs
+sudo journalctl -u report-engine.service -f
+```
+
+## Documentation
+While the service is running properly, Swagger documentation can be accessed at [localhost:8001/docs](localhost:8001/docs).
 
 ![swagger.png](./images/swagger.png)
diff --git a/README_EN.md b/README_EN.md
diff --git a/README_TR.md b/README_TR.md
@@ -0,0 +1,17 @@
+# 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.
+
+```bash
+sudo apt install ./report-engine-47.deb
+# servis loglarını görüntülemek için
+sudo journalctl -u report-engine.service -f
+```
+
+## 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)