From 9b93fde3b3cf06f177e5ae7a5fffc0d66aa80a29 Mon Sep 17 00:00:00 2001
From: rohitt <crohitp9@gmail.com>
Date: Wed, 10 Jul 2024 21:18:09 +0530
Subject: [PATCH] Documentation update

---
 .idea/workspace.xml | 22 +++++++++++++++-------
 README.md           | 33 +++++++++++++++++----------------
 2 files changed, 32 insertions(+), 23 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 55de54b..af323c5 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -9,10 +9,9 @@
     <option name="autoReloadType" value="NONE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="13abd5e3-ab9d-48e1-8162-3a7f069442df" name="Changes" comment="New Feature Updates">
+    <list default="true" id="13abd5e3-ab9d-48e1-8162-3a7f069442df" name="Changes" comment="Documentation update">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/gradle.properties" beforeDir="false" afterPath="$PROJECT_DIR$/gradle.properties" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/publish.gradle" beforeDir="false" afterPath="$PROJECT_DIR$/publish.gradle" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -22,7 +21,7 @@
   <component name="ClangdSettings">
     <option name="formatViaClangd" value="false" />
   </component>
-  <component name="ExecutionTargetManager" SELECTED_TARGET="device_and_snapshot_combo_box_target[DeviceId(pluginId=PhysicalDevice, isTemplate=false, identifier=serial=7f589762)]" />
+  <component name="ExecutionTargetManager" SELECTED_TARGET="device_and_snapshot_combo_box_target[DeviceId(pluginId=LocalEmulator, isTemplate=false, identifier=path=/Users/rohitchavan/.android/avd/Pixel_3a_API_34_extension_level_7_arm64-v8a.avd)]" />
   <component name="ExternalProjectsData">
     <projectState path="$PROJECT_DIR$">
       <ProjectState />
@@ -123,7 +122,7 @@
     &quot;project.structure.last.edited&quot;: &quot;Modules&quot;,
     &quot;project.structure.proportion&quot;: &quot;0.17&quot;,
     &quot;project.structure.side.proportion&quot;: &quot;0.2&quot;,
-    &quot;settings.editor.selected.configurable&quot;: &quot;emulator&quot;
+    &quot;settings.editor.selected.configurable&quot;: &quot;preferences.pluginManager&quot;
   },
   &quot;keyToStringList&quot;: {
     &quot;kotlin-gradle-user-dirs&quot;: [
@@ -493,7 +492,15 @@
       <option name="project" value="LOCAL" />
       <updated>1720464393651</updated>
     </task>
-    <option name="localTasksCounter" value="38" />
+    <task id="LOCAL-00038" summary="Documentation update">
+      <option name="closed" value="true" />
+      <created>1720624786323</created>
+      <option name="number" value="00038" />
+      <option name="presentableId" value="LOCAL-00038" />
+      <option name="project" value="LOCAL" />
+      <updated>1720624786323</updated>
+    </task>
+    <option name="localTasksCounter" value="39" />
     <servers />
   </component>
   <component name="Vcs.Log.Tabs.Properties">
@@ -519,6 +526,7 @@
     <MESSAGE value="New CropType added - Profile Circle.&#10; - For cropping the image specifically for user profile view added and circular overlay and circle shape for cropping." />
     <MESSAGE value="Documentation Update" />
     <MESSAGE value="New Feature Updates" />
-    <option name="LAST_COMMIT_MESSAGE" value="New Feature Updates" />
+    <MESSAGE value="Documentation update" />
+    <option name="LAST_COMMIT_MESSAGE" value="Documentation update" />
   </component>
 </project>
\ No newline at end of file
diff --git a/README.md b/README.md
index ee14aae..a9a1f6e 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,15 @@
 # Jetpack Compose ImageCropView
 
-Image crop view for jetpack compose applications.
 
-ImageCropView(`@Composable`) is a Jetpack Compose library for easy and customizable image cropping view in Android apps. 
+ImageCropView is a Jetpack Compose library that provides a simple and customizable image cropping view for Android applications.
 
-
-It supports various cropping styles like free-form, square, and circular cropping for profile pictures, making it simple to integrate cropping functionality into your Compose UI.
+It supports various cropping styles such as free-form, square, and circular cropping, making it easy to integrate image cropping functionality into your Compose UI.
 
 
 https://github.com/rroohit/ImageCropView/assets/36406595/d856d353-ab62-42c5-83db-ea99f8b4e8d8
 
 
-
-## Add in your project 
+## Setup
 
 
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.rroohit/ImageCropView/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.rroohit/ImageCropView)
@@ -25,9 +22,9 @@ dependencies {
 }
 ```
 
-## Using the ImageCropView 
+## Usage
 
-First We have to create an instance of `ImageCrop(bitmap)` by passing an bitmap. 
+Create an instance of `ImageCrop(bitmap)` by passing an bitmap. 
 
 Using `.ImageCropView(...)` you can customize your crop view.
 `.ImageCropView(...)` is jetpack compose `@Composable` function.
@@ -39,25 +36,29 @@ To get cropped bitmap invoke `.onCrop()`.
 private lateinit var imageCrop: ImageCrop
 imageCrop = ImageCrop(bitmap)
 
-// You can customize ImageCropView with following attributes.
+// Configure ImageCropView. 
 imageCrop.ImageCropView(
     modifier = Modifier,            
     guideLineColor = Color.LightGray,
     guideLineWidth = 2.dp,
     edgeCircleSize = 5.dp,
     showGuideLines = true,
-    cropType = CropType.SQUARE
+    cropType = CropType.SQUARE,
+    edgeType = EdgeType.CIRCULAR
 )
 
-imageCrop.onCrop() // To get the cropped image in bitmap format.
+val croppedBitmap = imageCrop.onCrop() // To get the cropped image in bitmap format.
 
-// Crop Types avail...
-// 1 - CropType.FREE_STYLE
-// 2 - CropType.SQUARE 
-// 3 - CropType.PROFILE_CIRCLE
+```
 
+## Crop Types
+
+| Crop Type          | Description                        |
+|--------------------|------------------------------------|
+| **FREE_STYLE**     | Free-form cropping                 |
+| **SQUARE**         | Square cropping                    |
+| **PROFILE_CIRCLE** | Circular View for profile pictures |
 
-```
 
 
 ### License