refactor: update README to clarify library functionality and remove o…#46
refactor: update README to clarify library functionality and remove o…#46shps951023 merged 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the README to reposition MiniPdf as an Excel-to-PDF converter and removes previously documented/obsolete capabilities and sections.
Changes:
- Update the library description and feature list to focus on Excel-to-PDF conversion.
- Remove Text-to-PDF usage examples and other sections (build/test instructions, project structure).
- Keep a single Excel-to-PDF usage example in the README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # MiniPdf | ||
|
|
||
| A minimal, zero-dependency .NET library for generating PDF documents from text and Excel (.xlsx) files. | ||
| A minimal, zero-dependency .NET library for converting Excel (.xlsx) files to PDF. |
There was a problem hiding this comment.
README now positions MiniPdf as Excel-to-PDF only, but the NuGet package metadata still describes “generating PDF documents from text and Excel files” and includes text in tags (src/MiniPdf/MiniPdf.csproj). Consider aligning the README wording with the packaged description/tags so users see consistent functionality across NuGet and GitHub.
| ## Usage | ||
|
|
||
| ### Simple Text PDF | ||
|
|
||
| ```csharp | ||
| using MiniPdf; | ||
|
|
||
| var doc = new PdfDocument(); | ||
| var page = doc.AddPage(); // US Letter size by default | ||
|
|
||
| page.AddText("Hello, World!", x: 50, y: 700, fontSize: 24); | ||
| page.AddText("This is MiniPdf.", x: 50, y: 670, fontSize: 12); | ||
|
|
||
| doc.Save("output.pdf"); | ||
| ``` | ||
|
|
||
| ### Auto-Wrapped Text | ||
|
|
||
| ```csharp | ||
| var doc = new PdfDocument(); | ||
| var page = doc.AddPage(); | ||
|
|
||
| var longText = "This is a long paragraph that will automatically wrap " | ||
| + "within the specified width boundary on the page."; | ||
|
|
||
| page.AddTextWrapped(longText, x: 50, y: 700, maxWidth: 500, fontSize: 12); | ||
|
|
||
| doc.Save("wrapped.pdf"); | ||
| ``` | ||
|
|
||
| ### Excel to PDF | ||
|
|
||
| ```csharp | ||
| using MiniPdf; | ||
|
|
There was a problem hiding this comment.
The usage section’s code sample (below) calls ExcelToPdfConverter and ExcelToPdfConverter.ConversionOptions, but those types are internal in the library (src/MiniPdf/ExcelToPdfConverter.cs). As published on NuGet, consumers won’t be able to compile the README example. Update the sample to use the public API (MiniPdf.ConvertToPdf(...)), or make the converter/options types public (or expose public overloads that accept options).
…bsolete sections