preparing for cocoapods

Author: jvk75

Example/CropperExample/CropperExample/ViewController.swift

@@ -12,7 +12,7 @@ class ViewController: UIViewController {
 
     @IBOutlet weak var imageView: UIImageView!
 
-    private var picker = UIImagePickerController()
+    private let picker = UIImagePickerController()
     private let cropper = UIImageCropper(cropRatio: 2/3)
 
     override func viewDidLoad() {

README.md

@@ -1,5 +1,82 @@
 # UIImageCropper
 
+Simple Image cropper for UIImagePickerController with customisable crop aspect ratio. Made purely with Swift 4!
+
+Replaces the iOS "crop only to square" functionality. Easy few line setup with delegate method/s.
+
+## Requirements
+
+- iOS10+
+- Xcode 9.2+
+- Swift 4
+
+
+## Install
+UIImageCropper is available through [CocoaPods](http://cocoapods.org). To install
+it, simply add the following line to your Podfile:
+
+```
+pod 'UIImageCropper'
+```
+
+ (or add UIImageCropper folder to your project)
+
+## Usage
+
+Import the pod
+
+```
+import UIImageCropper
+```
+
+Create instanses of UIImagePickerController and UIImageCropper
+
+UIImageCropper can take  ```cropRatio``` as parameter.  Default ratio is 1 (square).
+
+```
+let picker = UIImagePickerController()
+let cropper = UIImageCropper(cropRatio: 2/3)
+```
+
+Setup UIImageCropper
+
+```
+cropper.picker = picker
+cropper.delegate = self
+//cropper.cropRatio = 2/3 //(can be set during runtime or in init)
+```
+
+Implement ```UIImageCropperProtocol```delegate method/s
+
+```
+func didCropImage(originalImage: UIImage?, croppedImage: UIImage?) {
+    imageView.image = croppedImage
+}
+
+//optional (if not implemented cropper will close itself and picker)
+func didCancel() {
+    picker.dismiss(animated: true, completion: nil)
+}
+
+```
+
+The UIImageCropper will handle the image picking (delegate methods). To start image picking just present the UIImagePickerController instance.
+
+```
+self.present(self.picker, animated: true, completion: nil)
+```
+
+For full usage exmaple see **CropperExample** in Example folder.
+
+## Coming soon
+
+* Possibility to use cropper without UIImagePickerController
+
+## Issues and contribution
+
+If you find any issues please add and issue to this repository.
+
+Improvements and/or fixes as pull requests are more than welcome.
 
 ## Author
 

UIImageCropper.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'UIImageCropper'
-  s.version          = '0.1.0'
+  s.version          = '1.0.0'
   s.summary          = 'Simple Image cropper for UIImagePickerController with customisable aspect ratio.'
 
 # This description is used to generate tags and improve search results.
@@ -18,7 +18,8 @@ Pod::Spec.new do |s|
 #   * Finally, don't worry about the indent, CocoaPods strips it!
 
   s.description      = <<-DESC
-Simple Image cropper for UIImagePickerController with customisable aspect ratio. Made purely with Swift!
+Simple UIImage cropper for UIImagePickerController with customisable crop aspect ratio. Made purely with Swift4!
+Replaces the iOS "crop only to square" functionality. Easy few line setup with delegate method.
 DESC
 
   s.homepage         = 'https://github.com/jvk75/UIImageCropper'