update documentation

joshmanders · joshmanders · commit 8bd33cd99f26 · 2025-03-16T13:50:51.000-05:00
diff --git a/README.md b/README.md
@@ -21,7 +21,8 @@
 ## Table of Contents
 
 - [Installation](#installation)
-- [Configuration](#configuration)
+- [Usage](#usage)
+  - [Blade Components](#blade-components)
 - [Disclaimer](#disclaimer)
 - [Contributions](#contributions)
 - [License](#license)
@@ -34,12 +35,10 @@ Requires PHP 8.2+ and Laravel 11+.
 composer require cloudinary-labs/cloudinary-laravel
 ```
 
-## Configuration
-
-Publish the configuration file:
+After you have installed the SDK, you can invoke the install command to set everything up:
 
 ```bash
-php artisan vendor:publish --provider="CloudinaryLabs\CloudinaryLaravel\CloudinaryServiceProvider" --tag="cloudinary-laravel-config"
+php artisan cloudinary:install
 ```
 
 Add your Cloudinary credentials to your `.env` file:
@@ -53,6 +52,99 @@ CLOUDINARY_NOTIFICATION_URL=
 > [!NOTE]  
 > You can get your `CLOUDINARY_URL` from your [Cloudinary console](https://cloudinary.com/console). It typically looks like this: `cloudinary://API_KEY:API_SECRET@CLOUD_NAME`. Make sure to replace `API_KEY`, `API_SECRET`, and `CLOUD_NAME` with your actual Cloudinary credentials.
 
+## Usage
+
+### Blade Components
+
+This package provides a few Blade components for easy integration of Cloudinary media in your Laravel views.
+
+#### Upload Widget
+
+You can use the `<x-cloudinary::widget /> Blade component that ships with this like so:
+
+```blade
+<!DOCTYPE html>
+<html>
+  <body>
+    <x-cloudinary::widget>Upload Files</x-cloudinary::widget>
+  </body>
+</html>
+```
+
+#### Image Component
+
+Basic usage:
+
+```blade
+<x-cloudinary::image public-id="example" />
+```
+
+With additional properties:
+
+```blade
+<x-cloudinary::image public-id="example" width="300" height="300" />
+```
+
+##### Properties available:
+
+| Property              | Required |
+| --------------------- | -------- |
+| `public-id`           | Yes      |
+| `width`               | No       |
+| `height`              | No       |
+| `alt`                 | No       |
+| `class`               | No       |
+| `crop`                | No       |
+| `gravity`             | No       |
+| `effect`              | No       |
+| `rotate`              | No       |
+| `colorize`            | No       |
+| `trim`                | No       |
+| `blur`                | No       |
+| `gray-scale`          | No       |
+| `black-white`         | No       |
+| `sepia`               | No       |
+| `redeye`              | No       |
+| `negate`              | No       |
+| `oil-paint`           | No       |
+| `vignette`            | No       |
+| `simulate-colorblind` | No       |
+| `pixelate`            | No       |
+| `unsharp-mask`        | No       |
+| `saturation`          | No       |
+| `contrast`            | No       |
+| `brightness`          | No       |
+| `gamma`               | No       |
+| `improve-mode`        | No       |
+| `shadow`              | No       |
+| `border`              | No       |
+| `round-corners`       | No       |
+| `bg-color`            | No       |
+| `art`                 | No       |
+| `cartoonify`          | No       |
+
+#### Video Component
+
+Basic usage:
+
+```blade
+<x-cloudinary::video public-id="example"></x-cloudinary::video>
+```
+
+With additional properties:
+
+```blade
+<x-cloudinary::video public-id="example" width="300" height="300" />
+```
+
+##### Properties available:
+
+| Property    | Required |
+| ----------- | -------- |
+| `public-id` | Yes      |
+| `width`     | No       |
+| `height`    | No       |
+
 ## Disclaimer
 
 > _This software/code provided under Cloudinary Labs is an unsupported pre-production prototype undergoing further development and provided on an “AS IS” basis without warranty of any kind, express or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. Furthermore, Cloudinary is not under any obligation to provide a commercial version of the software.</br> </br> Your use of the Software/code is at your sole risk and Cloudinary will not be liable for any direct, indirect, incidental, special, exemplary, consequential or similar damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of the Software, even if advised of the possibility of such damage.</br> </br> You should refrain from uploading any confidential or personally identifiable information to the Software. All rights to and in the Software are and will remain at all times, owned by, or licensed to Cloudinary._
