Update README.md and CHANGELOG.md

burhanrashid52 · Jan 17, 2023 · e6a4233 · e6a4233
1 parent fed472b
commit e6a4233
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -84,4 +84,10 @@ new TextStyleBuilder()
 - New/Break : #383 Get a callback when the image source is touched `onTouchSourceImage(MotionEvent event);`
 
 ### 2.0.0
-- New : Migrated the app and library to Kotlin
+- New : Migrated the app and library to Kotlin
+
+### 3.0.0
+- New : Arrow shape
+- Change : (Breaking Change) Shape names are no longer UPPERCASE
+- Change : `saveAsFile(String, [SaveSettings,] OnSaveListener)` and `saveAsBitmap([SaveSettings,] OnSaveBitmap)` are deprecated use `saveAsFile(String[, SaveSettings])` and `saveAsBitmap([SaveSettings])`
+- Fixed : #374 `IndexOutOfBoundsException` when saving bitmap
diff --git a/README.md b/README.md
@@ -110,14 +110,14 @@ We can customize our brush and paint with different set of property. To start dr
 
 ![](https://i.imgur.com/INi5LIy.gif)
 
-| Type  | Method |
-| ------------- | ------------- |
-| Enable/Disable  | `mPhotoEditor.setBrushDrawingMode(true);` |
-| Shape (brush, line, oval, rectangle)  | `mPhotoEditor.addShape(shape)` |
-| Shape size (px)  | `mPhotoEditor.setBrushSize(brushSize)` or through the a ShapeBuilder |
-| Shape opacity (In %)  |   `mPhotoEditor.setOpacity(opacity)` or through the a ShapeBuilder |
-| Shape color | `mPhotoEditor.setBrushColor(colorCode)` or through the a ShapeBuilder |
-| Brush Eraser  | `mPhotoEditor.brushEraser()` |
+| Type                                         | Method                                                                 |
+|----------------------------------------------|------------------------------------------------------------------------|
+| Enable/Disable                               | `mPhotoEditor.setBrushDrawingMode(true);`                              |
+| Shape (brush, line, oval, rectangle, arrow)  | `mPhotoEditor.addShape(shape)`                                         |
+| Shape size (px)                              | `mPhotoEditor.setBrushSize(brushSize)` or through the a ShapeBuilder   |
+| Shape opacity (In %)                         | `mPhotoEditor.setOpacity(opacity)` or through the a ShapeBuilder       |
+| Shape color                                  | `mPhotoEditor.setBrushColor(colorCode)` or through the a ShapeBuilder  |
+| Brush Eraser                                 | `mPhotoEditor.brushEraser()`                                           |
 
 **Note**: Whenever we set any property of a brush for drawing it will automatically enable the drawing mode
 
@@ -126,15 +126,15 @@ We can draw shapes from [v.1.5.0](https://github.com/burhanrashid52/PhotoEditor/
 
 ![](https://im2.ezgif.com/tmp/ezgif-2-5d5f7ddbe72e.gif)
 
-```java
-mShapeBuilder = new ShapeBuilder()
-         .withShapeOpacity(100)
-         .withShapeType(ShapeType.OVAL)
-         .withShapeSize(50);
+```kotlin
+val shapeBuilder = ShapeBuilder()
+    .withShapeOpacity(100)
+    .withShapeType(ShapeType.Oval)
+    .withShapeSize(50f);
 
-mPhotoEditor.setShape(mShapeBuilder)
+photoEditor.setShape(mShapeBuilder)
 ```
-For more details check [ShapeBuilder](https://github.com/burhanrashid52/PhotoEditor/blob/master/photoeditor/src/main/java/ja/burhanrashid52/photoeditor/shape/ShapeBuilder.java).
+For more details check [ShapeBuilder](https://github.com/burhanrashid52/PhotoEditor/blob/master/photoeditor/src/main/java/ja/burhanrashid52/photoeditor/shape/ShapeBuilder.kt).
 
 ## Filter Effect
 We can apply inbuild filter to the source images using