Update readme

zetbaitsu · Jan 26, 2020 · a7d7ddf · a7d7ddf
1 parent 48f71fe
commit a7d7ddf
Show file tree

Hide file tree

Showing 4 changed files with 134 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -7,47 +7,73 @@ Compressor is a lightweight and powerful android image compression library. Comp
 # Gradle
 ```groovy
 dependencies {
-    implementation 'id.zelory:compressor:2.1.0'
+    implementation 'id.zelory:compressor:3.0.0'
 }
 ```
 # Let's compress the image size!
 #### Compress Image File
-```java
-compressedImageFile = new Compressor(this).compressToFile(actualImageFile);
+```kotlin
+val compressedImageFile = Compressor.compress(context, actualImageFile)
 ```
-#### Compress Image File to Bitmap
-```java
-compressedImageBitmap = new Compressor(this).compressToBitmap(actualImageFile);
+#### Compress Image File to specific destination
+```kotlin
+val compressedImageFile = Compressor.compress(context, actualImageFile) {
+    default()
+    destination(myFile)
+}
 ```
 ### I want custom Compressor!
-```java
-compressedImage = new Compressor(this)
-            .setMaxWidth(640)
-            .setMaxHeight(480)
-            .setQuality(75)
-            .setCompressFormat(Bitmap.CompressFormat.WEBP)
-            .setDestinationDirectoryPath(Environment.getExternalStoragePublicDirectory(
-              Environment.DIRECTORY_PICTURES).getAbsolutePath())
-            .compressToFile(actualImage);
+#### Using default constraint and custom partial of it
+```kotlin
+val compressedImageFile = Compressor.compress(context, actualImageFile) {
+    default(width = 640, format = Bitmap.CompressFormat.WEBP)
+}
+```
+#### Full custom constraint
+```kotlin
+val compressedImageFile = Compressor.compress(context, actualImageFile) {
+    resolution(1280, 720)
+    quality(80)
+    format(Bitmap.CompressFormat.WEBP)
+    size(2_097_152) // 2 MB
+}
+```
+#### Using your own custom constraint
+```kotlin
+class MyLowerCaseNameConstraint: Constraint {
+    override fun isSatisfied(imageFile: File): Boolean {
+        return imageFile.name.all { it.isLowerCase() }
+    }
+
+    override fun satisfy(imageFile: File): File {
+        val destination = File(imageFile.parent, imageFile.name.toLowerCase())
+        imageFile.renameTo(destination)
+        return destination
+    }
+}
+
+val compressedImageFile = Compressor.compress(context, actualImageFile) {
+    constraint(MyLowerCaseNameConstraint()) // your own constraint
+    quality(80) // combine with compressor constraint
+    format(Bitmap.CompressFormat.WEBP)
+}
+```
+### Compressor now is using Kotlin coroutines!
+#### Calling Compressor should be done from coroutines scope
+```kotlin
+// e.g calling from activity lifecycle scope
+lifecycleScope.launch {
+    val compressedImageFile = Compressor.compress(context, actualImageFile)
+}
+
+// calling from global scope
+GlobalScope.launch {
+    val compressedImageFile = Compressor.compress(context, actualImageFile)
+}
 ```
-### Stay cool compress image asynchronously with RxJava!
-```java
-new Compressor(this)
-        .compressToFileAsFlowable(actualImage)
-        .subscribeOn(Schedulers.io())
-        .observeOn(AndroidSchedulers.mainThread())
-        .subscribe(new Consumer<File>() {
-            @Override
-            public void accept(File file) {
-                compressedImage = file;
-            }
-        }, new Consumer<Throwable>() {
-            @Override
-            public void accept(Throwable throwable) {
-                throwable.printStackTrace();
-                showError(throwable.getMessage());
-            }
-        });
+#### Run Compressor in main thread
+```kotlin
+val compressedImageFile = Compressor.compress(context, actualImageFile, Dispatchers.Main)
 ```
 
 License

diff --git a/README_v2.md b/README_v2.md
@@ -0,0 +1,67 @@
+Compressor
+======
+[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Compressor-blue.svg?style=flat)](http://android-arsenal.com/details/1/3758)
+<p align="center"><img src="https://raw.githubusercontent.com/zetbaitsu/Compressor/master/ss.png" width="50%" /></p>
+Compressor is a lightweight and powerful android image compression library. Compressor will allow you to compress large photos into smaller sized photos with very less or negligible loss in quality of the image.
+
+# Gradle
+```groovy
+dependencies {
+    implementation 'id.zelory:compressor:2.1.0'
+}
+```
+# Let's compress the image size!
+#### Compress Image File
+```java
+compressedImageFile = new Compressor(this).compressToFile(actualImageFile);
+```
+#### Compress Image File to Bitmap
+```java
+compressedImageBitmap = new Compressor(this).compressToBitmap(actualImageFile);
+```
+### I want custom Compressor!
+```java
+compressedImage = new Compressor(this)
+            .setMaxWidth(640)
+            .setMaxHeight(480)
+            .setQuality(75)
+            .setCompressFormat(Bitmap.CompressFormat.WEBP)
+            .setDestinationDirectoryPath(Environment.getExternalStoragePublicDirectory(
+              Environment.DIRECTORY_PICTURES).getAbsolutePath())
+            .compressToFile(actualImage);
+```
+### Stay cool compress image asynchronously with RxJava!
+```java
+new Compressor(this)
+        .compressToFileAsFlowable(actualImage)
+        .subscribeOn(Schedulers.io())
+        .observeOn(AndroidSchedulers.mainThread())
+        .subscribe(new Consumer<File>() {
+            @Override
+            public void accept(File file) {
+                compressedImage = file;
+            }
+        }, new Consumer<Throwable>() {
+            @Override
+            public void accept(Throwable throwable) {
+                throwable.printStackTrace();
+                showError(throwable.getMessage());
+            }
+        });
+```
+
+License
+-------
+    Copyright (c) 2016 Zetra.
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
diff --git a/app/build.gradle b/app/build.gradle
@@ -28,7 +28,8 @@ dependencies {
     implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$kotlin_coroutines_version"
     implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.2.0'
     implementation 'androidx.appcompat:appcompat:1.1.0'
-    implementation project(':compressor')
+    //implementation project(':compressor')
+    implementation 'id.zelory:compressor:3.0.0-beta'
 
     testImplementation 'junit:junit:4.12'
 }
diff --git a/compressor/build.gradle b/compressor/build.gradle
@@ -28,7 +28,7 @@ ext {
     siteUrl = 'https://github.com/zetbaitsu/Compressor'
     gitUrl = 'https://github.com/zetbaitsu/Compressor.git'
 
-    libraryVersion = '2.1.0'
+    libraryVersion = '3.0.0-beta'
 
     developerId = 'zetbaitsu'
     developerName = 'Zetra'
@@ -47,7 +47,7 @@ android {
         minSdkVersion 14
         targetSdkVersion 29
         versionCode 5
-        versionName "2.1.0"
+        versionName "3.0.0-beta"
     }
     buildTypes {
         release {
@@ -74,3 +74,7 @@ dependencies {
 repositories {
     mavenCentral()
 }
+
+tasks.withType(Javadoc).all {
+    enabled = false
+}