Skip to content

Commit

Permalink
Updated readme with info of project.
Browse files Browse the repository at this point in the history
Closes #4.
Set version to 1.0.
  • Loading branch information
DJGosnell committed Feb 3, 2022
1 parent d5742c8 commit f7355bc
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 5 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Dtronix
Copyright (c) 2022 Dtronix

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,25 @@
# DtronixPdf
# DtronixPdf [![NuGet](https://img.shields.io/nuget/v/DtronixPdf.svg?maxAge=60)](https://www.nuget.org/packages/DtronixPdf) [![Action Workflow](https://github.com/Dtronix/DtronixPdf/actions/workflows/dotnet.yml/badge.svg)](https://github.com/Dtronix/DtronixPdf/actions)

PDF editor and viewer based on PDFium.
DtronixPdf is a .NET 5.0 library to handle interactions with PDFs via the PDFium library which is inherently not thread safe. This library will serialize all calls which are made to the PDFium backend and execute them all on a single thread via a dispatcher. Results are then returned through Tasks to the calling site.

#### References
Supports Linux-x64, OSX-x64, Win-x64, Win-x86.

https://github.com/Dtronix/PDFiumCore
[Project Roadmap](https://github.com/orgs/Dtronix/projects/1)

### Usage

- [Nuget Package](https://www.nuget.org/packages/DtronixPdf).
- Manual building. `dotnet build -c Release`

### Build Requirements
- .NET 5.0

### References

- https://github.com/Dtronix/PDFiumCore
- https://pdfium.googlesource.com/pdfium/
- https://github.com/bblanchon/pdfium-binaries
- https://github.com/mono/CppSharp

### License
[MIT](LICENSE) License
1 change: 1 addition & 0 deletions src/DtronixPdf/DtronixPdf.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<TargetFramework>net5.0</TargetFramework>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<Version>1.0.0</Version>
</PropertyGroup>
<ItemGroup>
<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
Expand Down

0 comments on commit f7355bc

Please sign in to comment.