Skip to content

Commit 16ef47d

Browse files
authored
README: Slightly improve the Migration section. (#520)
1 parent 7573cea commit 16ef47d

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,13 @@ override fun showImageSourceDialog(openSource: (Source) -> Unit) {
135135

136136
## Migrating from Android Image Cropper
137137

138-
Add this library like it's shown above.
138+
Start by using [Version 4.3.3](https://github.com/CanHub/Android-Image-Cropper/releases/tag/4.3.3):
139+
140+
```groovy
141+
dependencies {
142+
implementation("com.vanniktech:android-image-cropper:4.3.3")
143+
}
144+
```
139145

140146
### Update all imports
141147

@@ -146,14 +152,16 @@ Add this library like it's shown above.
146152
+import com.canhub.cropper.CropImageActivity
147153
```
148154

149-
# Update all XML references
155+
### Update all XML references
150156

151157
```diff
152158
-<com.theartofdev.edmodo.cropper.CropImageView
153159
+<com.canhub.cropper.CropImageView
154160
```
155161

156-
Consult with the sample app on how to use our Activity Contracts since `onActivityResult` got deprecated.
162+
When using Activity Contracts, consult with the sample app on how to use our Activity Contracts since `onActivityResult` got deprecated.
163+
164+
Versions after 4.3.3 have changed the APIs quite a bit, it's best to upgrade to each minor version individually, remove deprecated API usages and continue upgrading. So after using 4.3.3, upgrade to 4.4.0, etc.
157165

158166
## License
159167

0 commit comments

Comments
 (0)