Skip to content

Commit 7565fe3

Browse files
committed
Updated README.md
1 parent b91952f commit 7565fe3

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,24 @@ This is an Open API based RESTful service that generates and reads Swiss QR code
77
- Scan a Swiss QR Code payment slip from an image or a PDF and parse its content.
88
- Generate a Swiss QR code payment slip in PNG, PDF or SVG format.
99

10-
The API is documented using the Open API standard, which -- once the service is running - you find under ``/swagger-docs``. There is also a very simple UI under ``/swagger-ui``.
10+
The API is documented using the Open API standard, which - once the service is running - you find under ``/swagger-docs``. There is also a very simple UI under ``/swagger-ui``.
1111

1212
## Building and running Swiss QR API
13-
Swiss QR API runs on the JVM and was written in Kotlin. In order to build Swiss QR API you will require *Java 11* or higher. The project comes with an integrated Gradle wrapper. Once you have checked out the source you can run it using ``./gradlew run`` or build it using ``./gradlew distTar`` or ``./gradlew distZip``.
13+
Swiss QR API runs on the JVM and was written in Kotlin. In order to build Swiss QR API you will require *Java JDK 21* or higher. The project comes with an integrated Gradle wrapper. Once you have checked out the source you can run it from within the project directory using ``./gradlew run`` or build it using ``./gradlew distTar`` or ``./gradlew distZip``.
1414

15-
Make sure you provide a path to a valid ``config.json`` file as program argument. Currently, you can only influence the port under which the Swiss QR API will run (8081 by default).
15+
Make sure you provide a path to a valid ``config.json`` file as program argument (see example file in project directory).
16+
17+
**Important:** The ``config.json`` can be used to configure the server port of the service (8081 by default). Furthermore, you can change / add API keys that can be used to interact with the service. It is recommended to change the default key for security reasons.
18+
19+
## Dockerfile
20+
21+
The project also comes with a Dockerfile, which can be used instead. You can build the Docker image from within the project directory using ```docker build .``` and run it using ```docker run -p 8081:8081 <image-id>```. Again, make sure you adjust the ``config.json`` file to your needs.
1622

1723
## Credits
18-
Swiss QR API relies on a bunch of great open source- libraries. The ones I would like to mention here are:
24+
Swiss QR API relies on a bunch of great open source-libraries. The ones I would like to mention here are:
1925

20-
- [SwissQRBill](https://github.com/manuelbl/SwissQRBill): An Java library to generate and decode Swiss QR bills .
26+
- [SwissQRBill](https://github.com/manuelbl/SwissQRBill): An Java library to generate and decode Swiss QR bills.
2127
- [Javalin](https://javalin.io/): An web server framework for Java and Kotlin.
22-
- [BoofCV](https://boofcv.org/): A computer vision framework for Java
28+
- [BoofCV](https://boofcv.org/): An amazing computer vision framework for Java.
2329

2430
Thanks a lot to the great work of all people involved in these libraries (and of course all the others, that did not get a mention here)!

0 commit comments

Comments
 (0)