Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
fix: fixed documentation of default value at imagePreprocessing
  • Loading branch information
kylixeza authored Apr 12, 2023
1 parent bdefe73 commit c38983b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ For now, Firetor just provide feature to upload single image to your storage but

### Image

Example 1:

```kotlin
post("/image") {
var url: String? = null
Expand All @@ -51,6 +53,8 @@ post("/image") {
}
```

Example 2:

```kotlin
post("/image-with-params") {
var url: String? = null
Expand Down Expand Up @@ -84,7 +88,7 @@ post("/image-with-params") {
| :------: | :--: | :---: | :-----------: | :-----: |
| `path` | `String` | To declare path of your image directory. If directory is null, it will be placed at default directory in storage | `null` | `"user/avatar"` |
| `imageExtension` | `ImageExtension` | To declare extension of your image | `ImageExtension.JPG` | `ImageExtension.JPEG` |
| `imagePreprocessing` | `ImagePreprocessing.(ByteArray) -> ByteArray` | To preprocessing image before uploaded | `this` | `it.compress(0.5f)` |
| `imagePreprocessing` | `ImagePreprocessing.(ByteArray) -> ByteArray` | To preprocessing image before uploaded | `it` | `it.compress(0.5f)` |

Here some ImagePreprocessing functions:
| Function | Parameters | Usage |
Expand Down

0 comments on commit c38983b

Please sign in to comment.