diff --git a/README.md b/README.md index 9f7b6c4d..9db90221 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@
A containerized API for seamless PDF conversion
@@ -23,41 +22,32 @@ numerous document formats (HTML, Markdown, Word, Excel, etc.) into PDF files, an Open a terminal and run the following command: -``` +```bash docker run --rm -p 3000:3000 gotenberg/gotenberg:8 ``` -Alternatively, using the historic Docker repository from our sponsor [TheCodingMachine](https://www.thecodingmachine.com): +With the API running at `http://localhost:3000`, you can immediately convert a URL to a PDF: -``` -docker run --rm -p 3000:3000 thecodingmachine/gotenberg:8 +```bash +curl \ + --request POST http://localhost:3000/forms/chromium/convert/url \ + --form url=https://sparksuite.github.io/simple-html-invoice-template/ \ + -o invoice.pdf ``` -The API is now available on your host at http://localhost:3000. - -Head to the [documentation](https://gotenberg.dev/docs/getting-started/introduction) to learn how to interact with it 🚀 +**Read the [Full Documentation](https://gotenberg.dev/docs/getting-started/introduction)** to discover how to convert local +files, inject custom CSS, merge PDFs, and more. ## Sponsors - +Open-source development takes time and effort. Support the continuous improvement of Gotenberg by [**becoming a sponsor**](https://github.com/sponsors/gulien)! ❤️ -Sponsorships help maintain and improve Gotenberg - [become a sponsor](https://github.com/sponsors/gulien) ❤️ +**GitHub Sponsors** ---- +- [TheCodingMachine](https://thecodingmachine.com/) +- [pdfme](https://pdfme.com/) -- Powered by -
+**Powered By** -
-
-
-
-