diff --git a/Source/QuestPDF/QuestPDF.csproj b/Source/QuestPDF/QuestPDF.csproj index 6b2e3c1..3674ef8 100644 --- a/Source/QuestPDF/QuestPDF.csproj +++ b/Source/QuestPDF/QuestPDF.csproj @@ -3,7 +3,7 @@ MarcinZiabek CodeFlint QuestPDF - 2022.12.0 + 2022.12.1 QuestPDF is an open-source, modern and battle-tested library that can help you with generating PDF documents by offering friendly, discoverable and predictable C# fluent API. $([System.IO.File]::ReadAllText("$(MSBuildProjectDirectory)/Resources/ReleaseNotes.txt")) 9 diff --git a/Source/QuestPDF/Resources/Description.md b/Source/QuestPDF/Resources/Description.md index fb6e695..5bfd2fe 100644 --- a/Source/QuestPDF/Resources/Description.md +++ b/Source/QuestPDF/Resources/Description.md @@ -1,41 +1,50 @@ -[![Dotnet](https://img.shields.io/badge/platform-.NET-blue)](https://www.nuget.org/packages/QuestPDF/) -[![GitHub Repo stars](https://img.shields.io/github/stars/QuestPDF/QuestPDF)](https://github.com/QuestPDF/QuestPDF/stargazers) -[![Nuget version](https://img.shields.io/nuget/v/QuestPdf)](https://www.nuget.org/packages/QuestPDF/) -[![Nuget download](https://img.shields.io/nuget/dt/QuestPDF)](https://www.nuget.org/packages/QuestPDF/) -[![License](https://img.shields.io/github/license/QuestPDF/QuestPDF)](https://github.com/QuestPDF/QuestPDF/blob/main/LICENSE) -[![Sponsor project](https://img.shields.io/badge/sponsor-project-red)](https://github.com/sponsors/QuestPDF) + + + -QuestPDF is an open-source .NET library for PDF documents generation. +--- -It offers a layout engine designed with a full paging support in mind. The document consists of many simple elements (e.g. border, background, image, text, padding, table, grid etc.) that are composed together to create more complex structures. This way, as a developer, you can understand the behavior of every element and use them with full confidence. Additionally, the document and all its elements support paging functionality. For example, an element can be moved to the next page (if there is not enough space) or even be split between pages like table's rows. All of it done with predictable and discoverable Fluent API. +[![QuestPDF Homepage](https://img.shields.io/badge/Homepage-blue?style=for-the-badge)](https://www.questpdf.com) +[![Dotnet](https://img.shields.io/badge/platform-.NET-blue?style=for-the-badge)](https://www.nuget.org/packages/QuestPDF/) +[![GitHub Repo stars](https://img.shields.io/github/stars/QuestPDF/QuestPDF?style=for-the-badge)](https://github.com/QuestPDF/QuestPDF/stargazers) +[![Nuget version](https://img.shields.io/nuget/v/QuestPdf?style=for-the-badge)](https://www.nuget.org/packages/QuestPDF/) +[![Nuget download](https://img.shields.io/nuget/dt/QuestPDF?style=for-the-badge)](https://www.nuget.org/packages/QuestPDF/) +[![License](https://img.shields.io/github/license/QuestPDF/QuestPDF?style=for-the-badge)](https://github.com/QuestPDF/QuestPDF/blob/main/LICENSE) -## Installation +
-The library is available as a nuget package. You can install it as any other nuget package from your IDE, try to search by `QuestPDF`. You can find package details [on this webpage](https://www.nuget.org/packages/QuestPDF/). +### QuestPDF is a modern open-source .NET library for PDF document generation. Offering comprehensive layout engine powered by concise and discoverable C# Fluent API. -```xml -// Package Manager -Install-Package QuestPDF + -// .NET CLI -dotnet add package QuestPDF + + + + + + + + + + + + + + + + + + + + + + + + + +
👨‍💻Design documents using C# and employ a code-only approach. Utilize your version control system to its fullest potential.
🧱Compose document with a range of powerful and predictable structural elements, such as text, image, border, table, and many more.
⚙️Utilize a comprehensive layout engine, specifically designed for document generation and paging support.
📖Write code using concise and easy-to-understand C# Fluent API. Utilize IntelliSense to quickly discover available options.
🔗Don't be limited to any proprietary scripting language or format. Follow your experience and leverage all modern C# features.
⌛Save time thanks to a hot-reload capability, allowing real-time document preview without code recompilation.
-// Package reference in .csproj file - -``` - -## Documentation - -[![Getting started tutorial]( https://img.shields.io/badge/%F0%9F%9A%80%20read-getting%20started-blue)](https://www.questpdf.com/documentation/getting-started.html) -A short and easy to follow tutorial showing how to design an invoice document under 200 lines of code. - - -[![API reference](https://img.shields.io/badge/%F0%9F%93%96%20read-API%20reference-blue)](https://www.questpdf.com/documentation/api-reference.html) -A detailed description of behavior of all available components and how to use them with C# Fluent API. - - -[![Patterns and Practices](https://img.shields.io/badge/%F0%9F%94%8D%20read-patterns%20and%20practices-blue)](https://www.questpdf.com/documentation/patterns-and-practices.html#document-metadata) -Everything that may help you designing great reports and create reusable code that is easy to maintain. +
## Simplicity is the key @@ -82,12 +91,14 @@ Document.Create(container => .GeneratePdf("hello.pdf"); ``` -And compare it to the produced PDF file: -![invoice](https://raw.githubusercontent.com/QuestPDF/QuestPDF-Documentation/main/images/minimal-example-shadow.png) -## Are you ready for more? +## Let's get started -The Fluent API of QuestPDF scales really well. It is easy to create and maintain even most complex documents. Read [the Getting started tutorial](https://www.questpdf.com/documentation/getting-started.html) to learn QuestPDF basics and implement an invoice under 200 lines of code. You can also investigate and play with the code from [the example repository](https://github.com/QuestPDF/example-invoice). +Begin exploring the QuestPDF library today. You are 250 lines of C# code away from creating a fully functional PDF invoice implementation. -![invoice](https://raw.githubusercontent.com/QuestPDF/QuestPDF-Documentation/main/images/invoice-small.png) +Read the Getting Started tutorial to familiarize yourself with general library architecture, important layout structures as well as to better understand helpful patterns and practices. + +[![Getting started tutorial](https://img.shields.io/badge/%F0%9F%9A%80%20read-getting%20started-blue?style=for-the-badge)](https://www.questpdf.com/getting-started) + +