Merge branch 'main' of https://github.com/rwbr/flutter_neat_pdf_viewer

# Conflicts:
#	README.md

README.md

@@ -1,15 +1,83 @@
 # flutter_neat_pdf_viewer
 
-A new Flutter package project.
+A flutter plugin for handling PDF files. Works on both Android & iOS. Originally forked from (https://github.com/CrossPT/flutter_plugin_pdf_viewer).
 
-## Getting Started
+[![Pub Package](https://img.shields.io/pub/v/advance_pdf_viewer.svg?style=flat-square)](https://pub.dartlang.org/packages/advance_pdf_viewer)
 
-This project is a starting point for a Dart
-[package](https://flutter.dev/developing-packages/),
-a library module containing code that can be shared easily across
-multiple Flutter or Dart projects.
 
-For help getting started with Flutter, view our 
-[online documentation](https://flutter.dev/docs), which offers tutorials, 
-samples, guidance on mobile development, and a full API reference.
-# flutter_neat_pdf_viewer
+## Installation
+
+Add  *flutter_neat_pdf_viewer*  as a dependency in [your pubspec.yaml file](https://flutter.io/platform-plugins/).
+```
+advance_pdf_viewer: any
+```
+
+---
+
+## Android
+No permissions required. Uses application cache directory.
+
+## iOS
+No permissions required.
+
+## How-to:
+
+#### Load PDF
+```
+// Load from assets
+PDFDocument doc = await PDFDocument.fromAsset('assets/test.pdf');
+ 
+// Load from URL
+PDFDocument doc = await PDFDocument.fromURL('http://www.africau.edu/images/default/sample.pdf');
+
+// Load from file
+File file  = File('...');
+PDFDocument doc = await PDFDocument.fromFile(file);
+```
+
+#### Load pages
+```
+// Load specific page
+PDFPage pageOne = await doc.get(page: _number);
+```
+
+#### Pre-built viewer
+Use the pre-built PDF Viewer
+```
+@override
+  Widget build(BuildContext context) {
+    Scaffold(
+        appBar: AppBar(
+          title: Text('Example'),
+        ),
+        body: Center(
+        child: _isLoading
+            ? Center(child: CircularProgressIndicator())
+            : PDFViewer(document: document)),
+    );
+  }
+```
+
+This code produces the following view:
+
+<img height="500px" src="https://raw.githubusercontent.com/lohanidamodar/pdf_viewer/master/demo.png" alt="Demo Screenshot 1"/>
+
+---
+
+## TODO
+
+* Allow password-protected files
+* ~~Refactor PDFDocument.getAll() method~~
+* ~~Increase page resolution~~
+* ~~Add swipe to change page~~
+
+---
+
+#### Third-party packages used
+
+| Name | Description  |
+|-|-|
+| [path_provider](https://pub.dartlang.org/packages/path_provider)               | A Flutter plugin for finding commonly used locations on the filesystem. Supports iOS and Android.            |
+| [flutter_cache_manager](https://pub.dartlang.org/packages/flutter_cache_manager)       | A CacheManager to download and cache files in the cache directory of the app. Various settings on how long to keep a file can be changed. |
+| [numberpicker](https://pub.dartlang.org/packages/numberpicker)                | NumberPicker is a custom widget designed for choosing an integer or decimal number by scrolling spinners. |
+| [flutter_advanced_networkimage](https://pub.dartlang.org/packages/flutter_advanced_networkimage) | An advanced image provider provides caching and retrying for flutter app. Now with zoomable widget and transition to image widget. |# flutter_neat_pdf_viewer