Skip to content

Commit

Permalink
Added explanation for the updates done on 2.1
Browse files Browse the repository at this point in the history
Added comments on the improvement done the on this new release 2.1
  • Loading branch information
Tourenathan-G5organisation authored Oct 2, 2017
1 parent 904a8d7 commit 6b9506d
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -55,15 +65,15 @@ Download
--------
#### Gradle
```groovy
compile 'com.iceteck.silicompressorr:silicompressor:2.0'
compile 'com.iceteck.silicompressorr:silicompressor:2.1'
```

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

0 comments on commit 6b9506d

Please sign in to comment.