Cordova Plugin - Simple PDF Viewer for Android
============================

**This project is currently in developing.**

SimplePdfViewer is mainly aimed to provide a cordova plugin to view PDF files 
(either local or online) in Android devices. 
The core part is based on <a href="http://mupdf.com">MuPDF</a>, which is
a lightweight PDF and XPS viewer.

## Overview
1. [Supported Platforms](#supported-platforms)
2. [Installation](#installation)
3. [Using the plugin](#using-the-plugin)
4. [License](#license)

## Supported Platforms ##

* Android TBD
* Cordova/Phonegap TBD

## Installation ##

```bash
# ~~ from master branch ~~
cordova plugin add https://github.com/lingjunjiang/SimplePdfViewer.git
```

## Using the plugin ##

```javascript
document.addEventListener('deviceready', function () {
    // TODO:
}, false);
```

### Common Arguments ###

TBD

## License ##

SimplePdfViewer is free software: you can redistribute it and/or modify it 
under the terms of the <a href="http://www.gnu.org/licenses/agpl-3.0.html">Affero GNU General Public License</a> as published 
by the Free Software Foundation, either version 3 of the License, 
or (at your option) any later version.

Cordova Plugin - Simple PDF Viewer for Android
============================

**This project is currently in developing.**

SimplePdfViewer is mainly aimed to provide a cordova plugin to view PDF files 
(either local or online) in Android devices. 
The core part is based on <a href="http://mupdf.com">MuPDF</a>, which is
a lightweight PDF and XPS viewer.

## Overview
1. [Supported Platforms](#supported-platforms)
2. [Installation](#installation)
3. [Using the plugin](#using-the-plugin)
4. [License](#license)

## Supported Platforms ##

* Android TBD
* Cordova/Phonegap TBD

## Installation ##

```bash
# ~~ from master branch ~~
cordova plugin add https://github.com/lingjunjiang/SimplePdfViewer.git
```

## Using the plugin ##

```javascript
document.addEventListener('deviceready', function () {
    // TODO:
    	//Currently, you need use the local file path
        var filePath = "/storage/emulated/0/Download/sample.pdf";
        SimplePdfViewer.openPDF(filePath,function(result){
            console.log("SimplePdfViewer:" + result);
        },function(error){
            console.log("SimplePdfViewer Error:" + error);
        });
}, false);
```

### Common Arguments ###

TBD

## License ##

SimplePdfViewer is free software: you can redistribute it and/or modify it 
under the terms of the <a href="http://www.gnu.org/licenses/agpl-3.0.html">Affero GNU General Public License</a> as published 
by the Free Software Foundation, either version 3 of the License, 
or (at your option) any later version.

Add code to show how to use SamplePdfViewer
Add code to show how to use SamplePdfViewer
