Merge remote-tracking branch 'origin/master' into master

README.md

@@ -1,19 +1,26 @@
-# UserImageExample
-This repository contains an open source sample application that implements a user image selector from an extern gallery, the sample is based on the <a href="https://github.com/niedev/RTranslator/blob/master/app/src/main/java/nie/translator/rtranslatordevedition/settings/UserImageContainer.java" target="_blank" rel="noopener noreferrer">UserImageContainer</a> class of <a href="https://github.com/niedev/RTranslator" target="_blank" rel="noopener noreferrer">RTranslator</a>.
+This repository contains an open source sample application that implements a user image selector from an extern gallery, the sample is based on the <a href="https://github.com/niedev/RTranslator/blob/master/app/src/main/java/nie/translator/rtranslatordevedition/settings/UserImageContainer.java" target="_blank" rel="noopener noreferrer">UserImageContainer</a> class of <a href="https://github.com/niedev/RTranslator" target="_blank" rel="noopener noreferrer">RTranslator</a>.<br /><br />
 The UserImageContainer is highly optimized (fixes a lot of bugs including the rotation bug) and work with a variety of different galleries, even when combined
 (you can use a gallery for pick and another for crop without problems)
 if you have problem with a specific gallery app please report it in Issues (I cannot guarantee that I will be able to fix the problem but I can try if I have time).
+<br /><br /><br />
+<p align="center">
+	<kbd>
+		<img src="https://github.com/niedev/UserImageExample/blob/master/images/image_selection.gif" >
+	</kbd>
+</p>
+<br /><br />
 
 The passages for make this example (and for use UserImageContainer in other project) from a new project with an empty activity are:
 
-- add an xml icon (user_icon.xml) to drawable
-- add the following permission to the manifest: 
+- Add an xml icon (user_icon.xml) to drawable to be displayed if none image is selected
+- Create an ImageView that will contain the image and pass it to the UserImageContainer constructor together with the activity that contains it (if it is contained in a fragment pass that too)
+- Add the following permission to the manifest: 
   ```
   <uses-permissionandroid:name="android.permission.READ_EXTERNAL_STORAGE"/>
   ```
-- override onActivityResult in the activity that was passed or in the fragment if it is not null and here call userImageContainer.onActivityResult passing the arguments
+- Override onActivityResult in the activity that was passed or in the fragment if it is not null and here call userImageContainer.onActivityResult passing the arguments
 of the onActivityResult overwritten and true or false respectively if you want to save the selected image or not (you can save it later with saveContent())
-- add this to the manifest:
+- Add this to the manifest:
   ```
   <provider
 	  android:name="androidx.core.content.FileProvider"
@@ -25,22 +32,21 @@ of the onActivityResult overwritten and true or false respectively if you want t
 		  android:resource="@xml/filepaths"/>
   </provider>
   ```
-- create the "filepaths.xml" file in the "xml" folder with the following content:
+- Create the "filepaths.xml" file in the "xml" folder with the following content:
   ```
   <paths>
 	  <cache-pathpath="temporary_images/"name="temporaryUserImage"/>
   </paths>
   ```
 
-
+<br /><br />
 For saving the image you can mark the last parameter of userImageContainer.onActivityResult with true, in this case the image will be saved automatically at the end of the crop, 
 if you want instead to save the image in another moment (maybe after an error check for other data) you can mark the save parameter of onActivityResult false and use
-userImageContainer.saveContent() and UserImageContainer will save the last cropped image.
-The saved image can be accessed with "new File(context.getFilesDir(), "user_image");" in this case context must be an Activity or an Application or a Service.
-
-In this case I have inserted the imageView in an activity but to make UserImageContainer work with an imageView contained in a fragment just insert the fragment 
-between the arguments and instead of overriding onActivityResult in the activity we will have to do it in the fragment, for an example of this see directlty the
-implementation in RTranslator 
-
+userImageContainer.saveContent() and UserImageContainer will save the last cropped image.<br />
+The saved image can be accessed with "new File(context.getFilesDir(), "user_image");" in this case context must be an Activity, an Application or a Service.
+<br /><br />
+In this example I have inserted the imageView in an activity but to make UserImageContainer work with an imageView contained in a fragment just insert the fragment 
+between the arguments and instead of overriding onActivityResult in the activity we will have to do it in the fragment, for an example of this see directlty the <a href="https://github.com/niedev/RTranslator/blob/master/app/src/main/java/nie/translator/rtranslatordevedition/settings/UserImageContainer.java" target="_blank" rel="noopener noreferrer">implementation in RTranslator</a>.
+<br /><br />
 Notes: onActivityResult overwritten will be called two times, one after selection and one after the crop, if the save parameter is true the image will be saved only after
 the crop, not the first time.