From ed4abe03cc985a6c3fca9887b7c1ee17916d55cc Mon Sep 17 00:00:00 2001 From: ToureNathan Date: Fri, 26 May 2017 17:35:49 +0100 Subject: [PATCH] include the user manual for the the version 2.0 Video and Images API have been updated --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 551dc7e..d90c9ef 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ # SiliCompressor -A powerful image compression library for Android. +A powerful, flexible and easy to use Video and Image compression library for Android. Description -------- +#### Image It's usually said that "A picture is worth a thousand words". Images adds flair and beauty to our android apps, but we usaully have problems with these images due to thier large size. With SiliCompressor you can now compress and use your images more smoothly. +#### Video +Due to the high resolution of our Smartphone cameras and cameras from other devices, Video files have become large in size and thus difficult for it to be shared with others on social apps, social media and even when we need to upload it on our server. With SiliCompressor you can now compress you video file while maintaining it quality. + Credit -------- -This image compressor project is inspired from [Void Canvas] blog from which the core part of the compressor was done. +This image compressor part of this project is inspired from [Void Canvas] blog from which the core part of the compressor was done. Usage -------- @@ -17,14 +21,17 @@ 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); +``` #### Compress an image and return the file path of the new image ```java -String filePath = SiliCompressor.with(Context).compress(imageUriString); +String filePath = SiliCompressor.with(Context).compress(imageUriString, destinationFile); ``` #### Compress an image and return the file path of the new image while deleting the source image ```java -String filePath = SiliCompressor.with(Context).compress(imageUriString, true); +String filePath = SiliCompressor.with(Context).compress(imageUriString, destinationFile, true); ``` #### Compress an image drawable and return the file path of the new image @@ -47,7 +54,7 @@ Download -------- #### Gradle ```groovy -compile 'com.iceteck.silicompressorr:silicompressor:1.1.0' +compile 'com.iceteck.silicompressorr:silicompressor:2.0' ``` ##### Maven @@ -55,7 +62,7 @@ compile 'com.iceteck.silicompressorr:silicompressor:1.1.0' com.iceteck.silicompressorr silicompressor - 1.1.0 + 2.0 aar ```