From 6b9506d4d015ba1324b1b5f888016a4d05858d16 Mon Sep 17 00:00:00 2001 From: ToureNathan Date: Mon, 2 Oct 2017 10:18:12 +0100 Subject: [PATCH] Added explanation for the updates done on 2.1 Added comments on the improvement done the on this new release 2.1 --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index edcc431..3ddb440 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,18 @@ To effectively use this library, you must make sure you have added the following ``` #### Compress a video file and return the file path of the new video ```java -String filePath = SiliCompressor.with(Context).compressVideo(sourceUriString, destinationUriString); +The compressVideo method is an overloaded method which gives you many definations: + +i. This takes in the sourceVideoUri and destionationDirPath as first and second parameter respectively. +String filePath = SiliCompressor.with(Context).compressVideo(sourceVideoUri, destionationDirPath); + +ii. This takes the sourceVideoPath and destionationDirPath as first and second parameter respectively. +String filePath = SiliCompressor.with(Context).compressVideo(sourceVideoPath, destionationDirPath); + ``` + +Both method definations mentioned above can also take the disired resulting compressesd video **outWidth, outHight and bitrate** + #### Compress an image and return the file path of the new image ```java String filePath = SiliCompressor.with(Context).compress(imageUriString, destinationFile); @@ -55,7 +65,7 @@ Download -------- #### Gradle ```groovy -compile 'com.iceteck.silicompressorr:silicompressor:2.0' +compile 'com.iceteck.silicompressorr:silicompressor:2.1' ``` ##### Maven @@ -63,7 +73,7 @@ compile 'com.iceteck.silicompressorr:silicompressor:2.0' com.iceteck.silicompressorr silicompressor - 2.0 + 2.1 aar ```