diff --git a/README.md b/README.md index 064d295..f7488e5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ After that you can run `docker-compose up --build`. SpringBooTex will run as an REST service by default on port 10800; -### Generating PDFs +## Generating PDFs PDF's are generated by sending an HTTP POST request to the endpoint "/api/generate-pdf" with a JSON payload: ``` { @@ -24,15 +24,15 @@ PDF's are generated by sending an HTTP POST request to the endpoint "/api/genera } ``` -#### Example: Generating a PDF from latex template +### Example: Generating a PDF from latex template See our example LaTex template in [`Doc/example.tex`](https://github.com/shuhanmirza/SpringBooTex/blob/main/Doc/example.tex) -You can see that, the variables are written between two `%` s. -https://github.com/shuhanmirza/SpringBooTex/blob/49782f4cdd94a3e620f92739f7b37f381c3d77c0/Doc/example.tex#L12-21 +You can see that, the variables are written between two `%` s. +https://github.com/shuhanmirza/SpringBooTex/blob/49782f4cdd94a3e620f92739f7b37f381c3d77c0/Doc/example.tex#L12-L21 -And the pdf has to embed an image named `universe.jpg` -https://github.com/shuhanmirza/SpringBooTex/blob/49782f4cdd94a3e620f92739f7b37f381c3d77c0/Doc/example.tex#L37-38 +And the pdf has to embed an image named `universe.jpg` +https://github.com/shuhanmirza/SpringBooTex/blob/49782f4cdd94a3e620f92739f7b37f381c3d77c0/Doc/example.tex#L37-L38 Let's prepare the JSON payload,