Update README.md

adimiz1 · web-flow · commit 506d17e58c69 · 2022-02-01T16:43:57.000+02:00
diff --git a/README.md b/README.md
@@ -1,34 +1,36 @@
 [![Build Status](https://travis-ci.org/cloudinary/cloudinary_java.svg?branch=master)](https://travis-ci.org/cloudinary/cloudinary_java)
-[![Maven Central](https://img.shields.io/maven-central/v/com.cloudinary/cloudinary-core.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3Acom.cloudinary)
-[![license](https://img.shields.io/github/license/cloudinary/cloudinary_js.svg?maxAge=2592000)]()
 
 Cloudinary
 ==========
 
-Cloudinary is a cloud service that offers a solution to a web application's entire image management pipeline. 
+## About
+The Cloudinary Java SDK allows you to quickly and easily integrate your application with Cloudinary.
+Effortlessly optimize and transform your cloud's assets.
 
-Easily upload images to the cloud. Automatically perform smart image resizing, cropping and conversion without installing any complex software. 
-Integrate Facebook or Twitter profile image extraction in a snap, in any dimension and style to match your website’s graphics requirements. 
-Images are seamlessly delivered through a fast CDN, and much much more. 
+### Additional documentation
+This Readme provides basic installation and usage information.
+For the complete documentation, see the [Java SDK Guide](https://cloudinary.com/documentation/java_integration).
 
-Cloudinary offers comprehensive APIs and administration capabilities and is easy to integrate with any web application, existing or new.
+## Table of Contents
+- [Key Features](#key-features)
+- [Version Support](#Version-Support)
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Setup](#Setup)
+    - [Transform and Optimize Assets](#Transform-and-Optimize-Assets)
+    - [File upload](#File-upload)
 
+## Key Features
+- [Transform](https://cloudinary.com/documentation/java_video_manipulation) and [optimize](https://cloudinary.com/documentation/java_image_manipulation#image_optimizations) assets (links to docs).
+- [Upload assets to cloud](https://cloudinary.com/documentation/java_image_and_video_upload)
 
-Cloudinary provides URL and HTTP based APIs that can be easily integrated with any Web development framework. 
+## Version Support
+| SDK Version    | Java 6+ |
+|----------------|---------|
+| 1.1.0 - 1.29.0 | V       |
 
-For Java, Cloudinary provides a library for simplifying the integration even further.
-
-**Notes:** 
-
-* There are three flavors of the library to support different HttpClient versions: cloudinary-http42, cloudinary-http43 and cloudinary-http44. 
-* For Android there's a separate library available at https://github.com/cloudinary/cloudinary_android
-
-## Getting started guide
-![](https://res.cloudinary.com/cloudinary/image/upload/see_more_bullet.png)  **Take a look at our [Getting started guide for Java](https://cloudinary.com/documentation/java_integration#getting_started_guide)**.
-
-## Setup ######################################################################
-
-The cloudinary_java library is available in [Maven Central](https://repo1.maven.org/maven2/com/cloudinary/). To use it, add the following dependency to your pom.xml :
+## Installation
+The cloudinary_java library is available in [Maven Central](https://mvnrepository.com/artifact/com.cloudinary/cloudinary-core). To use it, add the following dependency to your pom.xml :
 
 ```xml
 <dependency>
@@ -41,52 +43,17 @@ The cloudinary_java library is available in [Maven Central](https://repo1.maven.
 Alternatively, download cloudinary_java from [here](https://repo1.maven.org/maven2/com/cloudinary/cloudinary-core/1.29.0/cloudinary-core-1.29.0.jar) and [here](https://repo1.maven.org/maven2/com/cloudinary/cloudinary-http44/1.29.0/cloudinary-http44-1.29.0.jar)
 and see [build.gradle](https://github.com/cloudinary/cloudinary_java/blob/master/cloudinary-http44/build.gradle) for library dependencies.
 
-## Try it right away
-
-Sign up for a [free account](https://cloudinary.com/users/register/free) so you can try out image transformations and seamless image delivery through CDN.
-
-*Note: Replace `demo` in all the following examples with your Cloudinary's `cloud name`.*  
-
-Accessing an uploaded image with the `sample` public ID through a CDN:
-
-    http://res.cloudinary.com/demo/image/upload/sample.jpg
-
-![Sample](https://res.cloudinary.com/demo/image/upload/w_0.4/sample.jpg "Sample")
-
-Generating a 150x100 version of the `sample` image and downloading it through a CDN:
-
-    http://res.cloudinary.com/demo/image/upload/w_150,h_100,c_fill/sample.jpg
-
-![Sample 150x100](https://res.cloudinary.com/demo/image/upload/w_150,h_100,c_fill/sample.jpg "Sample 150x100")
-
-Converting to a 150x100 PNG with rounded corners of 20 pixels: 
-
-    http://res.cloudinary.com/demo/image/upload/w_150,h_100,c_fill,r_20/sample.png
-
-![Sample 150x150 Rounded PNG](https://res.cloudinary.com/demo/image/upload/w_150,h_100,c_fill,r_20/sample.png "Sample 150x150 Rounded PNG")
-
-For plenty more transformation options, see our [image transformations documentation](http://cloudinary.com/documentation/image_transformations).
-
-Generating a 120x90 thumbnail based on automatic face detection of the Facebook profile picture of Bill Clinton:
- 
-    http://res.cloudinary.com/demo/image/facebook/c_thumb,g_face,h_90,w_120/billclinton.jpg
-    
-![Facebook 90x120](https://res.cloudinary.com/demo/image/facebook/c_thumb,g_face,h_90,w_120/billclinton.jpg "Facebook 90x200")
-
-For more details, see our documentation for embedding [Facebook](https://cloudinary.com/documentation/facebook_profile_pictures) and [Twitter](https://cloudinary.com/documentation/twitter_profile_pictures) profile pictures.
-
 ## Usage
+### Setup
 
-### Configuration
-
-Each request for building a URL of a remote cloud resource must have the `cloud_name` parameter set. 
-Each request to our secure APIs (e.g., image uploads, eager sprite generation) must have the `api_key` and `api_secret` parameters set. 
+Each request for building a URL of a remote cloud resource must have the `cloud_name` parameter set.
+Each request to our secure APIs (e.g., image uploads, eager sprite generation) must have the `api_key` and `api_secret` parameters set.
 See [API, URLs and access identifiers](https://cloudinary.com/documentation/solution_overview#account_and_api_setup) for more details.
 
-Setting the `cloud_name`, `api_key` and `api_secret` parameters can be done either directly in each call to a Cloudinary method, 
+Setting the `cloud_name`, `api_key` and `api_secret` parameters can be done either directly in each call to a Cloudinary method,
 by when initializing the Cloudinary object, or by using the CLOUDINARY_URL environment variable / system property.
 
-The entry point of the library is the Cloudinary object. 
+The entry point of the library is the Cloudinary object.
 ```java
 Cloudinary cloudinary = new Cloudinary();
 ```
@@ -105,8 +72,8 @@ Another example of setting the configuration parameters by providing the CLOUDIN
 
     Cloudinary cloudinary = new Cloudinary("cloudinary://123456789012345:abcdeghijklmnopqrstuvwxyz12@n07t21i7");
 
-### Embedding and transforming images
-
+### Transform and Optimize Assets
+- [See full documentation](https://cloudinary.com/documentation/java_image_manipulation)
 Any image uploaded to Cloudinary can be transformed and embedded using powerful view helper methods:
 
 The following example generates the url for accessing an uploaded `sample` image while transforming it to fill a 100x150 rectangle:
@@ -115,38 +82,29 @@ The following example generates the url for accessing an uploaded `sample` image
 cloudinary.url().transformation(new Transformation().width(100).height(150).crop("fill")).generate("sample.jpg");
 ```
 
-Another example, emedding a smaller version of an uploaded image while generating a 90x90 face detection based thumbnail: 
+Another example, emedding a smaller version of an uploaded image while generating a 90x90 face detection based thumbnail:
 
 ```java
 cloudinary.url().transformation(new Transformation().width(90).height(90).crop("thumb").gravity("face")).generate("woman.jpg");
 ```
 
-You can provide either a Facebook name or a numeric ID of a Facebook profile or a fan page.  
-             
+You can provide either a Facebook name or a numeric ID of a Facebook profile or a fan page.
+
 Embedding a Facebook profile to match your graphic design is very simple:
 
 ```java
 cloudinary.url().type("facebook").transformation(new Transformation().width(130).height(130).crop("fill").gravity("north_west")).generate("billclinton.jpg");
 ```
 
-Same goes for Twitter:
-
-```java
-cloudinary.url().type("twitter_name").generate("billclinton.jpg");
-```
-
-![](https://res.cloudinary.com/cloudinary/image/upload/see_more_bullet.png) **See [our documentation](https://cloudinary.com/documentation/java_image_manipulation) for more information about displaying and transforming images in Java**.
-
-### Upload
-
+### File upload
 Assuming you have your Cloudinary configuration parameters defined (`cloud_name`, `api_key`, `api_secret`), uploading to Cloudinary is very simple.
-    
-The following example uploads a local JPG to the cloud: 
+
+The following example uploads a local JPG to the cloud:
 
 ```java
 cloudinary.uploader().upload("my_picture.jpg", ObjectUtils.emptyMap());
 ```
-        
+
 The uploaded image is assigned a randomly generated public ID. The image is immediately available for download through a CDN:
 
 ```java
@@ -155,7 +113,7 @@ cloudinary.url().generate("abcfrmo8zul1mafopawefg.jpg");
 # http://res.cloudinary.com/demo/image/upload/abcfrmo8zul1mafopawefg.jpg
 ```
 
-You can also specify your own public ID:    
+You can also specify your own public ID:
 
 ```java
 cloudinary.uploader().upload("http://www.example.com/image.jpg", ObjectUtils.asMap("public_id", "sample_remote"));
@@ -165,60 +123,26 @@ cloudinary.url().generate("sample_remote.jpg");
 # http://res.cloudinary.com/demo/image/upload/sample_remote.jpg
 ```
 
-![](https://res.cloudinary.com/cloudinary/image/upload/see_more_bullet.png) **See [our documentation](https://cloudinary.com/documentation/java_image_upload) for plenty more options of uploading to the cloud from your Java code**.        
-
-### imageTag
-
-Returns an html image tag pointing to Cloudinary.
-
-Usage:
-
-```java
-cloudinary.url().format("png").transformation(new Transformation().width(100).height(100).crop("fill")).imageTag("sample");
-
-# <img src='http://res.cloudinary.com/cloud_name/image/upload/c_fill,h_100,w_100/sample.png' height='100' width='100'/>
-```
-
-### imageUploadTag
-
-Returns an html input field for direct image upload, to be used in conjunction with [cloudinary\_js package](https://github.com/cloudinary/cloudinary_js/). It integrates [jQuery-File-Upload widget](https://github.com/blueimp/jQuery-File-Upload) and provides all the necessary parameters for a direct upload.
-
-Usage:
-
-```java
-Map options = ObjectUtils.asMap("resource_type", "auto");
-Map htmlOptions = ObjectUtils.asMap("alt", "sample");
-String html = cloudinary.uploader().imageUploadTag("image_id", options, htmlOptions);
-```
-
-![](https://res.cloudinary.com/cloudinary/image/upload/see_more_bullet.png) **See [our documentation](https://cloudinary.com/documentation/java_image_upload#direct_uploading_from_the_browser) for plenty more options of uploading directly from the browser**.
-  
-## Additional resources ##########################################################
-
-Additional resources are available at:
-
-* [Website](https://cloudinary.com)
-* [Interactive demo](https://demo.cloudinary.com/default)
-* [Knowledge Base](https://support.cloudinary.com/hc/en-us) 
-* [Documentation](https://cloudinary.com/documentation)
-* [Documentation for Java integration](https://cloudinary.com/documentation/java_integration)
-* [Image transformations documentation](https://cloudinary.com/documentation/image_transformations)
-* [Upload API documentation](https://cloudinary.com/documentation/upload_images)
-
-## Support
-
-You can [open an issue through GitHub](https://github.com/cloudinary/cloudinary_java/issues).
-
-Contact us [https://cloudinary.com/contact](https://cloudinary.com/contact)
-
-Stay tuned for updates, tips and tutorials: [Blog](https://cloudinary.com/blog), [Twitter](https://twitter.com/cloudinary), [Facebook](https://www.facebook.com/Cloudinary).
-
-## Join the Community ##########################################################
-
-Impact the product, hear updates, test drive new features and more! Join [here](https://www.facebook.com/groups/CloudinaryCommunity).
-
-
-## License #######################################################################
-
-Released under the MIT license. 
-
+## Contributions
+See [contributing guidelines](/CONTRIBUTING.md).
+
+## Get Help
+- [Open a Github issue](https://github.com/CloudinaryLtd/cloudinary_java/issues) (for issues related to the SDK)
+- [Open a support ticket](https://cloudinary.com/contact) (for issues related to your account)
+
+## About Cloudinary
+Cloudinary is a powerful media API for websites and mobile apps alike, Cloudinary enables developers to efficiently manage, transform, optimize, and deliver images and videos through multiple CDNs. Ultimately, viewers enjoy responsive and personalized visual-media experiences—irrespective of the viewing device.
+
+## Additional Resources
+- [Cloudinary Transformation and REST API References](https://cloudinary.com/documentation/cloudinary_references): Comprehensive references, including syntax and examples for all SDKs.
+- [MediaJams.dev](https://mediajams.dev/): Bite-size use-case tutorials written by and for Cloudinary Developers
+- [DevJams](https://www.youtube.com/playlist?list=PL8dVGjLA2oMr09amgERARsZyrOz_sPvqw): Cloudinary developer podcasts on YouTube.
+- [Cloudinary Academy](https://training.cloudinary.com/): Free self-paced courses, instructor-led virtual courses, and on-site courses.
+- [Code Explorers and Feature Demos](https://cloudinary.com/documentation/code_explorers_demos_index): A one-stop shop for all code explorers, Postman collections, and feature demos found in the docs.
+- [Cloudinary Roadmap](https://cloudinary.com/roadmap): Your chance to follow, vote, or suggest what Cloudinary should develop next.
+- [Cloudinary Facebook Community](https://www.facebook.com/groups/CloudinaryCommunity): Learn from and offer help to other Cloudinary developers.
+- [Cloudinary Account Registration](https://cloudinary.com/users/register/free): Free Cloudinary account registration.
+- [Cloudinary Website](https://cloudinary.com)
+
+## Licence
+Released under the MIT license.
