Skip to content

Update readme #352

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sgong-pdftron merged 6 commits into from
Jan 26, 2026
Merged

Update readme #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b34b39a
update readme
sgong-pdftron Jan 26, 2026
5c3f86f
Updating package version
github-actions[bot] Jan 26, 2026
82bae24
Update to match React Native
sgong-pdftron Jan 26, 2026
1239884
Merge branch 'wrapper-readme-update' of https://github.com/ApryseSDK/…
sgong-pdftron Jan 26, 2026
cec5242
Updating pubspec.yaml
github-actions[bot] Jan 26, 2026
e41d94a
Updating package version
github-actions[bot] Jan 26, 2026
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
25 changes: 9 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,7 @@
## About PDFTron Flutter
PDFTron's Flutter PDF library brings smooth, flexible, and stand-alone document viewing and editing solutions using Flutter codebases for iOS and Android applications.
## About PDFTron Flutter Wrapper

- Direct MS Office document viewing and conversion
- Fully customizable open source UI to improve app engagement
- Document reflow to increase readability and accessibility on mobile
- File streaming to view remote and complex documents faster
- Night mode to improve viewing in low-light environments
- And much more...

More information can be found at https://docs.apryse.com/documentation/guides/flutter/

**Android**|**iOS**
:--:|:--:
<img src="https://pdftron.s3.amazonaws.com/custom/websitefiles/flutter/flutter-pdftron-demo-android.gif" alt="A gif showcasing the UI and some features on Android"/>|<img src="https://pdftron.s3.amazonaws.com/custom/websitefiles/flutter/flutter-pdftron-demo-ios.gif" alt="A gif showcasing the UI and some features on iOS"/>

## Contents
> [!IMPORTANT]
> This repository serves as a wrapper around the native SDKs. It exposes only a limited set of APIs intended for basic viewing, annotating and removing components from the out‑of‑box UI. Any advanced customization or access to lower‑level functionality should be performed directly through the native SDKs rather than this wrapper.

- [API](https://pub.dev/documentation/pdftron_flutter/latest/pdftron/pdftron-library.html)
- [Prerequisites](#prerequisites)
Expand All @@ -27,6 +14,12 @@ More information can be found at https://docs.apryse.com/documentation/guides/fl
- [Contributing](#contributing)
- [License](#license)

## Preview

**Android**|**iOS**
:--:|:--:
<img src="https://pdftron.s3.amazonaws.com/custom/websitefiles/flutter/flutter-pdftron-demo-android.gif" alt="A gif showcasing the UI and some features on Android"/>|<img src="https://pdftron.s3.amazonaws.com/custom/websitefiles/flutter/flutter-pdftron-demo-ios.gif" alt="A gif showcasing the UI and some features on iOS"/>

## Prerequisites
- No license key is required for trial. However, a valid commercial license key is required after trial.
- PDFTron SDK >= 6.9.0
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: pdftron_flutter
description: A convenience wrapper to build Flutter apps that use the PDFTron mobile SDK for smooth, flexible, and stand-alone document viewing.
version: 1.0.1-52
version: 1.0.1-53
homepage: https://www.apryse.com
repository: https://github.com/ApryseSDK/pdftron-flutter
issue_tracker: https://github.com/ApryseSDK/pdftron-flutter/issues
Expand Down