Pārlūkot izejas kodu

Improved package description

MarcinZiabek 2 gadi atpakaļ
vecāks
revīzija
fb02d97a10
1 mainītis faili ar 22 papildinājumiem un 41 dzēšanām
  1. 22 41
      Source/QuestPDF/Resources/PackageReadme.md

+ 22 - 41
Source/QuestPDF/Resources/PackageReadme.md

@@ -1,48 +1,29 @@
-<a href="https://www.questpdf.com/" target="_blank">
-  <img src="https://github.com/QuestPDF/example-invoice/raw/main/images/logo.svg" width="400"> 
-</a>
-
----
-
-[![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/)
+[![QuestPDF Homepage](https://img.shields.io/badge/Homepage-3366cc?style=for-the-badge)](https://www.questpdf.com)
+[![Getting started](https://img.shields.io/badge/Getting%20started-3366cc?style=for-the-badge)](https://www.questpdf.com/getting-startedm)
+[![API Reference](https://img.shields.io/badge/API%20Reference-3366cc?style=for-the-badge)](https://www.questpdf.com/api-reference/index)
+[![Design patterns](https://img.shields.io/badge/Design%20patterns-3366cc?style=for-the-badge)](https://www.questpdf.com/design-patterns)
 [![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)
 
 <br />
 
-### QuestPDF is a modern open-source .NET library for PDF document generation. Offering comprehensive layout engine powered by concise and discoverable C# Fluent API.
-
-<img src="https://github.com/QuestPDF/QuestPDF-Documentation/blob/main/docs/public/previewer/animation.gif?raw=true" width="100%">
-
-<table>
-<tr>
-    <td>👨‍💻</td>
-    <td>Design documents using C# and employ a code-only approach. Utilize your version control system to its fullest potential.</td>
-</tr>
-<tr>
-    <td>🧱</td>
-    <td>Compose document with a range of powerful and predictable structural elements, such as text, image, border, table, and many more.</td>
-</tr>
-<tr>
-    <td>⚙️</td>
-    <td>Utilize a comprehensive layout engine, specifically designed for document generation and paging support.</td>
-</tr>
-<tr>
-    <td>📖</td>
-    <td>Write code using concise and easy-to-understand C# Fluent API. Utilize IntelliSense to quickly discover available options.</td>
-</tr>
-<tr>
-    <td>🔗</td>
-    <td>Don't be limited to any proprietary scripting language or format. Follow your experience and leverage all modern C# features.</td>
-</tr>
-<tr>
-    <td>⌛</td>
-    <td>Save time thanks to a hot-reload capability, allowing real-time document preview without code recompilation.</td>
-</tr>
-</table>
+### QuestPDF is a modern open-source .NET library for PDF document generation. Offering comprehensive layout engine powered by concise and discoverable C# Fluent API. Easily generate PDF documents, reports, invoices, etc.
+
+![Usage animation](https://github.com/QuestPDF/QuestPDF-Documentation/blob/main/docs/public/previewer/animation.gif?raw=true)
+
+👨‍💻 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.
+
 
 <br />
 
@@ -50,7 +31,7 @@
 
 How easy it is to start and prototype with QuestPDF? Really easy thanks to its minimal API! Please analyse the code below:
 
-```#
+```csharp
 using QuestPDF.Fluent;
 using QuestPDF.Helpers;
 using QuestPDF.Infrastructure;
@@ -101,4 +82,4 @@ Read the Getting Started tutorial to familiarize yourself with general library a
 
 [![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)
 
-<img src="https://github.com/QuestPDF/QuestPDF-Documentation/blob/main/docs/public/invoice-small.png?raw=true" width="400px">
+![Example invoice](https://github.com/QuestPDF/QuestPDF-Documentation/blob/main/docs/public/invoice-small.png?raw=true)