diff --git a/README.md b/README.md index 55ed54d..0c00785 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,17 @@ The TiExplorer module enables you to read files from Internal/External storage a This project can be found on github at [https://github.com/wecobi/TiExplorer](here). -##Before you start +## Before you start * This is an Android module designed to work with Titanium SDK 7.0.0 or greater. -##Accessing the TiExplorer Module - +## Accessing the TiExplorer Module To access this module from JavaScript, you would do the following: -

-var TiExplorer = require("ti.explorer");
-
- -###Method +
var TiExplorer = require("ti.explorer");
-###selectFile +### Method +### selectFile

 TiExplorer.selectFile({
 	mimeType: "application/vnd.ms-excel",
@@ -36,32 +32,32 @@ TiExplorer.selectFile({
 		Ti.API.info("onError>>>> " + JSON.stringify(e));
 	}
 });
-
+ You can create an request for SelectFile using below properties +* mimeType (Optional) (String) MimeType of file you want to read. (Default, */*) +* location (Optional) (Constant) TiExplorer Defined Constant used to give location of file. (Default, CACHE_DIRECTORY) +* onSuccess (Required) (Function) Successful response, then you can get response in here. +* onSuccess (Required) (Function) An Error response you get here. -*mimeType (Optional) (String) MimeType of file you want to read. (Default, */*) -*location (Optional) (Constant) TiExplorer Defined Constant used to give location of file. (Default, CACHE_DIRECTORY) -*onSuccess (Required) (Function) Successful response, then you can get response in here. -*onSuccess (Required) (Function) An Error response you get here. -###Constant +### Constant ###Result Response status -
RESULT_OK
-
RESULT_CANCELED
-
RESULT_ERROR
+* RESULT_OK +* RESULT_CANCELED +* RESULT_ERROR -###Storage location -
EXTERNAL_STORAGE
-
CACHE_DIRECTORY
-
DATA_DIRECTORY
-
EXTERNAL_CACHE_DIRECTORY
+### Storage location +* EXTERNAL_STORAGE +* CACHE_DIRECTORY +* DATA_DIRECTORY +* EXTERNAL_CACHE_DIRECTORY -##Author -*Abidhusain Chidi -*[mailto:abidhusain.wecobi@gmail.com](abidhusain.wecobi@gmail.com) - -##Licensing & Support +## Author +* Abidhusain Chidi +* abidhusain.wecobi@gmail.com +## Licensing & Support This project is licensed under the MIT approved License. For details please see the license associated with each project. +