Skip to content

Commit

Permalink
updated the README.md
Browse files Browse the repository at this point in the history
Added description of version 1.1 to the ReadMe
  • Loading branch information
Tourenathan-G5organisation committed May 9, 2016
1 parent cd796d2 commit 9615b20
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,56 @@
A powerful image compression library for Android.


Usage
Description
--------
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.

#### Compress an image return the file path of the new image
Usage
--------
To effectively use this library, you must make sure you have added the following permission to your project.
```java
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
```

#### Compress an image and return the file path of the new image
```java
String filePath = SiliCompressor.with(Context).compress(imageUriString);
```
#### 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);
```

#### Compress an image drawable and return the file path of the new image
```java
String filePath = SiliCompressor.with(Context).compress(R.drawable.icon);
```

#### Compress an image and return the bitmap data of the new image
```java
String filePath = SiliCompressor.with(Context).getCompressBitmap(imageUriString);
```

#### Compress an image and return the bitmap data of the new image while deleting the source image
```java
String filePath = SiliCompressor.with(Context).getCompressBitmap(imageUriString, true);
```


Download
--------
#### Gradle
```groovy
compile 'com.iceteck.silicompressorr:silicompressor:1.0.0'
compile 'com.iceteck.silicompressorr:silicompressor:1.1.0'
```

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

0 comments on commit 9615b20

Please sign in to comment.