Skip to content

Commit 34645c2

Browse files
committed
readme update
1 parent 9084ad7 commit 34645c2

File tree

1 file changed

+30
-54
lines changed

1 file changed

+30
-54
lines changed

README.md

+30-54
Original file line numberDiff line numberDiff line change
@@ -17,73 +17,50 @@ $ ./pdfix_app make-accessible -i test.pdf -o output.pdf
1717

1818
For additional CLI options, refer to the [PDFix SDK Command-Line Interface documentation](https://pdfix.net/support/pdfix-command-line/). The CLI application is included in the downloadable package available on the [PDFix website](https://pdfix.net/download/).
1919

20-
## Integration Using the SDK
20+
## Integration the SDK programatically
2121

22-
### C#
23-
To integrate PDFix with C#, install the NuGet package [PDFix.SDK](https://www.nuget.org/packages/PDFix.SDK/):
22+
To integrate the PDFix SDK programmatically, refer to the code examples on GitHub for your preferred programming language:
2423

25-
```cs
26-
using PDFixSDK.Pdfix;
24+
- [C++](https://github.com/pdfix/pdfix_sdk_example_cpp) – Native applications
25+
- [.NET](https://github.com/pdfix/pdfix_sdk_example_dotnet) – For .NET Framework, .NET Core, and .NET 5+
26+
- [Java](https://github.com/pdfix/pdfix_sdk_example_java) – For Maven or Gradle projects
27+
- [Python](https://github.com/pdfix/pdfix_sdk_example_python) – Applications
28+
- [JavaScript](https://github.com/pdfix/pdfix_sdk_example_npm) – For frameworks like Node.js, React.js, Angular, and similar
2729

28-
static void Main() {
29-
var pdfix = new Pdfix();
30-
var doc = pdfix.OpenDoc("Sample.pdf", "");
31-
// Perform PDF operations
32-
doc.Close();
33-
}
34-
```
35-
Find more examples on [GitHub](https://github.com/pdfix/pdfix_sdk_example_dotnet).
30+
## How to
3631

37-
### C++
32+
### Fix Accessibility Issues
3833

39-
```cpp
40-
#include "Pdfix.h"
34+
To fix PDF/UA compliance issues in a PDF document use methods available in:
4135

42-
Pdfix_statics;
36+
- **PDFix Actions for Accessibility** - a flexible pdf manipulation without coding
37+
- **SDK API methods** to access and edit
38+
- Structure Tree and its Elements
39+
- Page Objects and their Content Marks
40+
- Annotations
41+
- Document Metadata
4342

44-
int main() {
45-
if (Pdfix_init(Pdfix_MODULE_NAME)) {
46-
auto pdfix = GetPdfix();
47-
auto doc = pdfix->OpenDoc(L"Sample.pdf", L"");
48-
// Perform PDF operations
49-
doc->Close();
50-
}
51-
}
52-
```
53-
Find more examples on [GitHub](https://github.com/pdfix/pdfix_sdk_example_cpp).
43+
### Extract PDF Content
5444

55-
### Java
45+
To extract the data from a PDF document a conversion to JSON. The data extraction can methods can provide:
5646

57-
```java
58-
import net.pdfix.pdfixlib.*;
47+
- **Raw Document Extraction** to access
48+
- Document Metadata, Form Fields, and classification such as tagged, signed, secured
49+
- Page Size, Rotation, Annotations, Content including text content, images, positions, colors
50+
- **Layout Recognition** to access the logical content such as
51+
- Paragraphs, Headings, Figures, Tables, Headers, Footers
52+
-
53+
- **Document Structure Tags** to access
54+
- Complete document structure tree with element properties, attributes, position, and content
5955

60-
public static void main() {
61-
Pdfix pdfix = new Pdfix();
62-
PdfDoc doc = pdfix.OpenDoc("Sample.pdf", "");
63-
// Perform PDF operations
64-
doc.Close();
65-
}
66-
```
67-
Find more examples on [GitHub](https://github.com/pdfix/pdfix_sdk_example_java).
6856

69-
### Python
70-
To integrate PDFix with Python, install the package [pdfix-sdk](https://pypi.org/project/pdfix-sdk/):
7157

72-
```python
73-
from pdfixsdk import *
74-
75-
pdfix = GetPdfix()
76-
doc = pdfix.OpenDoc("Sample.pdf", "")
77-
# Perform PDF operations
78-
doc.close()
79-
```
80-
Find more examples on [GitHub](https://github.com/pdfix/pdfix_sdk_example_python).
8158

8259
## Multi-Threaded Environments
8360

84-
PDFix SDK is designed for single-threaded processing, meaning only one API method can be executed at a time within a single process. Any method calls from other threads will wait until the preceding one completes.
61+
PDFix SDK operates in a single-threaded manner, allowing only one API method to run at a time within a single process. Any additional method calls from other threads will be queued until the current operation finishes.
8562

86-
For concurrent processing, use separate processes instead of threads.
63+
For parallel processing, use separate processes rather than threads.
8764

8865
## Licensing
8966

@@ -92,9 +69,8 @@ For concurrent processing, use separate processes instead of threads.
9269

9370
### Trial/Lite License Limitations
9471

95-
- Extracted text may have randomly replaced characters with "*".
96-
- Rasterized images may contain a watermark.
97-
- Saved PDFs may have redacted content.
72+
- Extracted text may include randomly replaced characters with "*".
73+
- Saved PDFs may contain redacted content with watermark.
9874

9975
## Prerequisites
10076

0 commit comments

Comments
 (0)