README

PSPDFKit Appcelerator Titanium Module
=====================================

** PSPDFKit needs Xcode 7.3.1 to compile and works with iOS 8.0 upwards. ***

IMPORTANT: PSPDFKit needs the "PSPDFKit.bundle" in the app directory. You find this bundle in:
PSPDFKit-Demo/PSPDFKit.embeddedframework/PSPDFKit.framework/Versions/A/Resurces/PSPDFKit.bundle.
Copy it to assets/iphone to be included.

INSTALL YOUR MODULE
--------------------

Copy the PSPDFKit.embeddedframework into the root folder.
You can download this framework from www.pspdfkit.com

./build.py
cp com.pspdfkit-iphone-5.X.X.zip /Library/Application\ Support/Titanium/


REGISTER YOUR MODULE
---------------------

Register your module with your application by editing `tiapp.xml` and adding your module.
Example:

<modules>
	<module version="5.X">com.pspdfkit</module>
</modules>

When you run your project, the compiler will know automatically compile in your module
dependencies and copy appropriate image assets into the application.

You also need to change the minimum deployment target. Add this to `tiapp.xml` by editing it in text.

    <ios>
        <min-ios-ver>8.0</min-ios-ver>
    </ios>


USING YOUR MODULE IN CODE
-------------------------

To use your module in code, you will need to require it.

For example,

	var pspdfkit = require('com.pspdfkit');
	pspdfkit.foo();


TESTING YOUR MODULE
-------------------

Run the `titanium.py` script to test your module or test from within XCode.
To test with the script, execute:

	titanium run --dir=YOURMODULEDIR


This will execute the app.js in the example folder as a Titanium application.

Cheers!