Improve and update README with current API examples #64

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.

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

Already on GitHub? Sign in to your account

Merged

Jaben merged 1 commit into develop from feature/readme-improvement

Oct 5, 2025

Merged

Improve and update README with current API examples #64

Improve and update README with current API examples

Annotations

12 warnings

Pack

The 'licenseUrl' element will be deprecated. Consider using the 'license' element instead.

Pack

File '/home/runner/work/GotenbergSharpApiClient/GotenbergSharpApiClient/src/Gotenberg.Sharp.Api.Client/Resources/gotenbergSharpClient-large.PNG' is not added because the package already contains file '/gotenbergSharpClient-large.PNG'

Build: src/Gotenberg.Sharp.Api.Client/Infrastructure/Constants.cs#L214

XML comment has badly formed XML -- 'Whitespace is not allowed at this location.'

Build: src/Gotenberg.Sharp.Api.Client/GotenbergSharpClient.cs#L90

Ambiguous reference in cref attribute: 'HtmlToPdfAsync'. Assuming 'GotenbergSharpClient.HtmlToPdfAsync(HtmlRequest, CancellationToken)', but could have also matched other overloads including 'GotenbergSharpClient.HtmlToPdfAsync(HtmlRequestBuilder, CancellationToken)'.

Build: src/Gotenberg.Sharp.Api.Client/GotenbergSharpClient.cs#L75