@bigbinary/neeto-image-uploader-frontend 1.4.2 → 1.4.4

package/README.md

@@ -11,6 +11,8 @@
 - [Components](#components)
   - [1. AssetLibrary](#1-assetlibrary)
   - [2. ImageUploader](#2-imageuploader)
+- [Hooks](#hooks)
+  - [1. useImageUpload](#1-useimageuploader)
 - [Development instructions](#development-instructions)
   - [Engine development](#engine-development)
   - [Frontend package development](#frontend-package-development)
@@ -35,27 +37,19 @@
   end
 ```
 
-2. Add the following two lines to the applications `Gemfile.rb` file:
-
-  ```ruby
-    gem "imagekitio"
-
-    gem "httparty"
-  ```
-
-3. Run the following command to install the engine:
+2. Run the following command to install the engine:
 
 ```shell
   bundle install
 ```
 
-4. Add the following line to your application's `config/routes.rb`:
+3. Add the following line to your application's `config/routes.rb`:
 
 ```ruby
   mount NeetoImageUploaderEngine::Engine => "/neeto_image_uploader_engine"
 ```
 
-5. Add the following keys to environment variables (all 6 keys are required):
+4. Add the following keys to environment variables (all 6 keys are required):
 
 ```zsh
   IMAGE_KIT_PUBLIC_KEY
@@ -66,7 +60,7 @@
   UNSPLASH_ACCESS_KEY #(for fetching images from unsplash)
 ```
 
-6. Add the following lines to `secrets.yml`:
+5. Add the following lines to `secrets.yml`:
 
 ```yml
   image_kit_public_key: <%= ENV["IMAGE_KIT_PUBLIC_KEY"] %>
@@ -76,7 +70,7 @@
   unsplash_access_key: <%= ENV["UNSPLASH_ACCESS_KEY"] %>
 ```
 
-7. Add the folowing linse in `application_helper.rb` inside `app/helpers` folder:
+6. Add the folowing linse in `application_helper.rb` inside `app/helpers` folder:
 
 ```ruby
   module ApplicationHelper
@@ -91,19 +85,12 @@
         }
       }
 
-      global_props.deep_merge!(
-        {
-          organization: {
-            subdomain: @organization.subdomain
-          }
-        }) # only required if organization subdomain information is not present in globalProps
-
       global_props.deep_merge!(image_kit_props)
     end
   end
 ```
 
-8. Add the following file `imagekitio.rb` inside `config/initializers`
+7. Add the following file `imagekitio.rb` inside `config/initializers`
 
 ```ruby
   # frozen_string_literal: true
@@ -139,6 +126,34 @@ The frontend exports two components `AssetLibrary` and `ImageUploader`.
   <img src="https://github.com/bigbinary/neeto-editor/assets/70290286/d293d887-38fd-4e55-a53d-dd591a52f053" alt="Image Uploader"/>
 </div>
 
+# Hooks
+
+## 1. useImageUpload
+
+  The `useImageUpload` hook is a React custom hook that simplifies the process of uploading images in your application. It handles both development and production scenarios, tracks upload progress, and provides a clean interface for image uploading.
+
+### Import the hook
+
+  ```jsx
+  import { useImageUpload } from "@bigbinary/neeto-image-uploader-frontend";
+  ```
+
+### Invoke the hook
+
+  ```jsx
+    const { uploadImage, uploadProgress, uploadedImage } = useImageUpload();
+  ```
+
+### Call uploadImage to Upload an Image
+
+  ```jsx
+    const handleImageUpload = async (file) => {
+      uploadImage(file, (uploadedImageData) => {
+        // Handle the uploaded image data
+      });
+    };
+  ```
+
 # Development instructions
 
 ## Engine development