Merge pull request #20 from hansemannn/refactor-ios

tidev · Mar 6, 2019 · bd30196 · bd30196
2 parents e44e31a + 3afc84a
commit bd30196
Show file tree

Hide file tree

Showing 45 changed files with 4,718 additions and 5,385 deletions.
diff --git a/.travis.yml b/.travis.yml
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -1,8 +1,5 @@
 @Library('pipeline-library') _
 
 buildModule {
-	// defaults:
-	//nodeVersion = '4.7.3' // Must have version set up on Jenkins master before it can be changed
-	//sdkVersion = '6.0.3.GA'
-	//androidAPILevel = '23' // if changed, must install on build nodes
+	sdkVersion = '7.5.1.GA'
 }
diff --git a/android/LICENSE → LICENSE b/android/LICENSE → LICENSE
diff --git a/README.md b/README.md
@@ -1,2 +1,71 @@
-ti.compression [![Build Status](https://travis-ci.org/appcelerator-modules/ti.compression.svg)](https://travis-ci.org/appcelerator-modules/ti.compression)
-=======
+# Ti.Compression Module
+
+## Description
+
+Lets you zip and unzip files.
+
+## Getting Started
+
+View the [Using Titanium Modules](http://docs.appcelerator.com/platform/latest/#!/guide/Using_Titanium_Modules) document for instructions on getting
+started with using this module in your application.
+
+## Accessing the Ti.Compression Module
+
+To access this module from JavaScript, you would do the following:
+
+```js
+var Compression = require('ti.compression');
+```
+
+## Functions
+
+### string zip(string archiveFile, string[] fileArray)
+
+Compresses all of the files you pass in "fileArray" to the specified "archiveFile".
+
+#### Arguments
+
+* string archiveFile: The path to the archive file to create
+* string[] fileArray: An array of files to compress
+
+Returns the string "success" if the operation succeeded, or an error message if something went wrong.
+
+### string unzip(string destinationFolder, string archiveFile, bool overwrite)
+
+Extracts the files in the archive file into the destination folder, optionally overriding existing files.
+
+#### Arguments
+
+* string destinationFolder: The destination folder for the extracted files
+* string archiveFile: The path to an existing compressed archive file
+* bool overwrite: Indicates if existing files should be overwritten
+
+Returns the string "success" if the operation succeeded, or an error message if something went wrong.
+
+## Usage
+
+To create an archive:  
+
+```js
+var result = Ti.Compression.zip('test.zip', [ 'a.dat', 'b.dat', 'c.dat' ];
+```
+
+To extract an archive:
+
+```js
+var result = Ti.Compression.unzip(Ti.Filesystem.applicationDataDirectory + 'data', 'test.zip', true);
+```
+
+See example for more details.
+
+## Author
+
+Clint Tredway
+
+## Feedback and Support
+
+Please direct all questions, feedback, and concerns to [[email protected]](mailto:[email protected]?subject=iOS%20Compression%20Module).
+
+## License
+
+Copyright(c) 2010-present by Axway Appcelerator. All Rights Reserved. Please see the LICENSE file included in the distribution for further details.
diff --git a/android/build.properties.example b/android/build.properties.example
diff --git a/android/documentation/changelog.md b/android/documentation/changelog.md
diff --git a/android/documentation/index.md b/android/documentation/index.md
diff --git a/android/hooks/README b/android/hooks/README
diff --git a/android/hooks/add.py b/android/hooks/add.py
diff --git a/android/hooks/install.py b/android/hooks/install.py
diff --git a/android/hooks/remove.py b/android/hooks/remove.py
diff --git a/android/hooks/uninstall.py b/android/hooks/uninstall.py
diff --git a/android/manifest b/android/manifest
@@ -8,7 +8,7 @@ architectures: arm64-v8a armeabi-v7a x86
 description: Lets you zip and unzip files.
 author: Dawson Toth
 license: Apache License, Version 2.0
-copyright: Copyright (c) 2010-2016 by Appcelerator, Inc.
+copyright: Copyright (c) 2010-present by Appcelerator, Inc.
 
 # these should not be edited
 name: compression