Standardized readme.md

Author: babar-raza

README.md

@@ -1,53 +1,92 @@
-# GroupDocs.Conversion Cloud Ruby SDK
-Ruby gem for communicating with the GroupDocs.Conversion Cloud API
+![](https://img.shields.io/badge/api-v2.0-lightgrey) ![Gem](https://img.shields.io/gem/v/groupdocs_conversion_cloud) ![Gem](https://img.shields.io/gem/dt/groupdocs_conversion_cloud) [![GitHub license](https://img.shields.io/github/license/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby)](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby/blob/master/LICENSE) 
 
-## Installation
+# Ruby SDK to Convert Documents in the Cloud
 
-A gem of groupdocs_conversion_cloud is available at [rubygems.org](https://rubygems.org). You can install it with:
+[GroupDocs.Conversion Cloud SDK for Ruby](https://products.groupdocs.cloud/conversion/ruby) wraps GroupDocs.Conversion RESTful APIs so you may integrate **Document Conversion** features in your own apps with zero initial cost.
+
+GroupDocs.Conversion Cloud API allows the developers to convert between 50+ file formats including Word documents, Excel spreadsheets, PowerPoint presentations, PDF, OpenDocument files, images & more.
+
+## Document Conversion REST API
+
+- Convert the whole document to the desired target format.
+- Convert specific document page(s) or a page range.
+- Auto-detect source document format without requiring the file extension.
+- Load source document with extended options, such as specify password for password-protected documents.
+- Load specific part of the document.
+- Show or hide document comments.
+- Obtain all supported conversion formats list.
+- Replace missing fonts with any other font.
+- Add text or image watermarks to any page.
+- Specify resolution and quality for resultant images.
+- Extract metadata & basic information about the source document.
+- Integrated storage API.
+
+Check out the [Developer's Guide](https://docs.groupdocs.cloud/conversion/developer-guide/) to know more about GroupDocs.Conversion REST API.
+
+## Microsoft File Formats
+
+**Microsoft Word:** DOC, DOCM, DOCX, DOT, DOTM, DOTX\
+**Microsoft Excel:** XLS, XLSX, XLSB, XLSM\
+**Microsoft PowerPoint:** PPT, PPTX, PPS, PPSX\
+**Microsoft Project:** MPP, MPT\
+**Microsoft Outlook:** MSG, EML\
+**Microsoft Visio:** VSD, VDX, VSS, VSX, VST, VTX, VSDX, VDW, VSSX, VSTX, VSDM, VSTM, VSSM\
+**Microsoft OneNote:** ONE
+
+## Other Formats
+
+**Page Layout Formats:** PDF, XPS\
+**OpenDocument:** ODT, OTT, ODS, ODP, OTP, OTS, ODG\
+**CAD:** DXF, DWG, IFC, STL\
+**Images:** DCM, BMP, GIF, JPG, PNG, TIFF, WebP, DjVu, SVG, DNG, ICO\
+**Web:** HTML, MHT, MHTML\
+**Emails:** EML, EMLX\
+**eBooks:** EPUB, MOBI\
+**Metafile:** WMF, EMF\
+**LaTeX:** TEX\
+**Others:** TXT, RTF, CSV, TSV, XML
+
+## Get Started with GroupDocs.Conversion Cloud SDK for Ruby
+
+First create an account at [GroupDocs for Cloud](https://dashboard.groupdocs.cloud/) and get your application information. Next, execute the following command to get the package.
 
 ```shell
 gem install groupdocs_conversion_cloud
 ```    
 
-To add dependency to your app copy following into your Gemfile and run `bundle install`:
+Copy the following into your Gemfile and run `bundle install` to add dependency to your app.
 
 ```
 gem "groupdocs_conversion_cloud", "~> 20.11"
 ```
 
-## Getting Started
+## Convert DOCX to PDF in the Cloud
 
-Please follow the [installation](#installation) procedure and then run the following code:
 ```ruby
-# Load the gem
+# Get your application information from https://dashboard.groupdocs.cloud
 require 'groupdocs_conversion_cloud'
 
-# Get your app_sid and app_key at https://dashboard.groupdocs.cloud (free registration is required).
-app_sid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
-app_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+$app_sid = "XXXX-XXXX-XXXX-XXXX" 
+$app_key = "XXXXXXXXXXXXXXXX"
 
-# Create instance of the API class
-api = GroupDocsConversionCloud::InfoApi.from_keys(app_sid, app_key)
+# Create necessary API instances
+apiInstance = GroupDocsConversionCloud::ConvertApi.from_keys($app_sid, $app_key)
 
-# Retrieve supported converison types
-request = GroupDocsConversionCloud::GetSupportedConversionTypesRequest.new
-response = api.get_supported_conversion_types(request)
+# Prepare convert settings
+settings = GroupDocsConversionCloud::ConvertSettings.new
+settings.file_path = "WordProcessing/four-pages.docx"
+settings.format = "pdf"
+settings.output_path = "converted"
 
-# Print out supported conversion types
-puts("Supported file-formats:")
-response.each do |format|
-puts("#{format.source_format} to [#{format.target_formats.join(', ')}]")
+# Convert
+result = apiInstance.convert_document(GroupDocsConversionCloud::ConvertDocumentRequest.new(settings))
 ```
 
-## Licensing
-GroupDocs.Conversion Cloud Ruby SDK licensed under [MIT License](LICENSE).
+## GroupDocs.Conversion Cloud SDKs in Popular Languages
 
-## Resources
-+ [**Website**](https://www.groupdocs.cloud)
-+ [**Product Home**](https://products.groupdocs.cloud/conversion)
-+ [**Documentation**](https://docs.groupdocs.cloud/display/conversioncloud/Home)
-+ [**Free Support Forum**](https://forum.groupdocs.cloud/c/conversion)
-+ [**Blog**](https://blog.groupdocs.cloud/category/conversion)
+| .NET | Java | PHP | Python | Ruby | Node.js | Android |
+|---|---|---|---|---|---|---|
+| [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-dotnet) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby)  | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-node) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-android) |
+| [NuGet](https://www.nuget.org/packages/GroupDocs.Conversion-Cloud/) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-conversion-cloud) | [Composer](https://packagist.org/packages/groupdocscloud/groupdocs-conversion-cloud) | [PIP](https://pypi.org/project/groupdocs-conversion-cloud/) | [GEM](https://rubygems.org/gems/groupdocs_conversion_cloud)  | [NPM](https://www.npmjs.com/package/groupdocs-conversion-cloud) |  | 
 
-## Contact Us
-Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.groupdocs.cloud/c/conversion).
+[Home](https://www.groupdocs.cloud/) | [Product Page](https://products.groupdocs.cloud/conversion/ruby) | [Documentation](https://docs.groupdocs.cloud/conversion/) | [Live Demo](https://products.groupdocs.app/conversion/total) | [API Reference](https://apireference.groupdocs.cloud/conversion/) | [Code Samples](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby-samples) | [Blog](https://blog.groupdocs.cloud/category/conversion/) | [Free Support](https://forum.groupdocs.cloud/c/conversion) | [Free Trial](https://dashboard.groupdocs.cloud)