Skip to content

Commit

Permalink
include the user manual for the the version 2.0
Browse files Browse the repository at this point in the history
Video and Images API have been updated
Tourenathan-G5organisation authored May 26, 2017
1 parent f9b8228 commit ed4abe0
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
```

#### 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,15 +54,15 @@ Download
--------
#### Gradle
```groovy
compile 'com.iceteck.silicompressorr:silicompressor:1.1.0'
compile 'com.iceteck.silicompressorr:silicompressor:2.0'
```

##### Maven
```xml
<dependency>
<groupId>com.iceteck.silicompressorr</groupId>
<artifactId>silicompressor</artifactId>
<version>1.1.0</version>
<version>2.0</version>
<type>aar</type>
</dependency>
```

0 comments on commit ed4abe0

Please sign in to comment.