Skip to content

fix: correct package readme example and add installation steps #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rsubrama83 merged 1 commit into from
Oct 2, 2026
Merged

fix: correct package readme example and add installation steps #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/ShinyPDF/Resources/PackageReadme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ ShinyPDF is a modern open-source .NET library for PDF document generation. Offer
馃敆 No proprietary template language. Use modern .NET features, reusable abstractions, and the tools you already trust.


## Installation

```bash
dotnet add package ShinyPDF
```

On Linux, also add the native assets for SkiaSharp and HarfBuzzSharp:

```bash
dotnet add package SkiaSharp.NativeAssets.Linux
dotnet add package HarfBuzzSharp.NativeAssets.Linux
```


## Simplicity is the key

How easy it is to start and prototype with ShinyPDF? Really easy thanks to its minimal API! Please analyse the code below that generates basic PDF document:
Expand All @@ -29,7 +43,7 @@ Document.Create(container =>
{
page.Size(PageSizes.A4);
page.Margin(2, Unit.Centimetre);
page.Background(Colors.White);
page.PageColor(Colors.White);
page.DefaultTextStyle(x => x.FontSize(20));

page.Header()
Expand Down
Loading