Standardized readme.md

Author: babar-raza

README.md

@@ -1,45 +1,46 @@
-## GroupDocs.Comparison for Java
 
-GroupDocs.Comparison is a lightweight library that allows you to merge and diff two versions of a document. Supported file formats include: PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, ODT, TXT, HTML.
+# Document Comparison Java Library
 
-## GroupDocs.Comparison Structure
-
-The core of GroupDocs.Comparison library consists of five main components: Words, Pdf, Slides, Cells and Text and Common . Each main component is divided into Contracts, Domain, that implements it, and Core component which compares documents using features specific for certain document type.
-All five main components have reference on Common.
-
-The Facade component gives an opportunity to simplify access to Comparison API and unites all comparison types into one API. Facade gives an ability to compare documents with all supported formats, and revise the changes from result document.
-
-This package contains [Examples](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Examples) for [GroupDocs.Comparison for Java](https://products.groupdocs.com/comparison/java) that will help you understand API's working and write your own applications.
+GroupDocs.Comparison for Java is a [Document Comparison API](https://products.groupdocs.com/comparison/java) that provides the ability to detect differences between source and target files for changes at paragraph, word and character levels as well as can identify styling and formatting changes. The API supports over [50 document types](https://docs.groupdocs.com/comparison/java/supported-document-formats/) from popular categories such as Microsoft Office, OpenOffice, AutoCAD, Visio, images, programming, PDF & more.
 
 <p align="center">
-
-  <a title="Download complete GroupDocs.Comparison for Java source code" href="https://codeload.github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/zip/master">
-	<img src="https://raw.github.com/AsposeExamples/java-examples-dashboard/master/images/downloadZip-Button-Large.png" />
+  <a title="Download complete GroupDocs.Comparison for Java source code" href="https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/archive/master.zip"> 
+    <img src="https://camo.githubusercontent.com/11839cd752a2d367f3149c7bee1742b68e4a4d37/68747470733a2f2f7261772e6769746875622e636f6d2f4173706f73654578616d706c65732f6a6176612d6578616d706c65732d64617368626f6172642f6d61737465722f696d616765732f646f776e6c6f61645a69702d427574746f6e2d4c617267652e706e67" data-canonical-src="https://raw.github.com/AsposeExamples/java-examples-dashboard/master/images/downloadZip-Button-Large.png" style="max-width:100%;">
   </a>
 </p>
 
 Directory | Description
 --------- | -----------
-[Examples](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Examples)  | Contains the package of Java examples and sample files that will help you learn how to use product features.
+[Docs](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Docs)  | Product documentation containing the Developer's Guide, Release Notes and more.
+[Examples](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Examples)  | Java examples and sample documents for you to get started quickly. 
+[Showcases](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Showcases)  | Build Document Comparison Applications with UI using GroupDocs.Comparison for Java. 
+
+## Compare Documents via Java
+
+- Accept or reject document changes.
+- [Adjust comparison sensitivity](https://docs.groupdocs.com/comparison/java/adjusting-comparison-sensitivity/).
+- Compare multiple documents at a time.
+- Get change coordinates on the document.
+- Set document metadata on save.
+- Set password for resultant document.
+- [Generate preview of document pages](https://docs.groupdocs.com/comparison/java/generate-document-pages-preview/).
+
+## Get Started with GroupDocs.Comparison for Java
 
-## How to Run the Examples
+GroupDocs.Comparison for Java requires J2SE 6.0 (1.6), J2SE 7.0 (1.7), J2SE 8.0 (1.8) or above. Please install Java first if you do not have it already. 
 
-+ You can either clone the repository using your favorite GitHub client or download the ZIP file from the above button.
-+ Extract the contents of the ZIP file to any folder on your computer.
-+ Open Java IDE and import the project to get started with it.
-+ On the first run, the dependencies will automatically be downloaded.
-+ Open MainClass.java file, all the examples are called from here.
-+ Uncomment the examples you want to run from within the project.
+GroupDocs hosts all Java APIs on [GroupDocs Artifact Repository](https://artifact.groupdocs.com/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-comparison), so simply [configure](https://docs.groupdocs.com/comparison/java/installation/) your Maven project to fetch the dependencies automatically.
 
-Please find more details for how to run the examples [here](https://docs.groupdocs.com/display/comparisonjava/How+to+Run+Examples).
+## Compare 2 PDF Documents
 
-##  Resources
+```java
+Comparer comparer = new Comparer("source.pdf");
+try {
+    comparer.add("target.pdf");
+    comparer.compare("result.pdf");
+} finally {
+    comparer.dispose();
+}
+```
 
-+ **Website:** [www.groupdocs.com](https://www.groupdocs.com)
-+ **Product Home:** [GroupDocs.Comparison for Java](https://products.groupdocs.com/comparison/java)
-+ **API Reference:** [GroupDocs.Comparison for Java API Reference](https://apireference.groupdocs.com/java/comparison)
-+ **Download:** [Download GroupDocs.Comparison for Java](https://artifact.groupdocs.com/repo/com/groupdocs/groupdocs-comparison/)
-+ **Documentation:** [GroupDocs.Comparison for Java Documentation](https://docs.groupdocs.com/display/comparisonjava/Home)
-+ **Free Support:** [GroupDocs.Comparison for Java Free Support Forum](https://forum.groupdocs.com/c/comparison)
-+ **Paid Support:** [GroupDocs.Comparison for Java Paid Support Helpdesk](https://helpdesk.groupdocs.com/)
-+ **Blog:** [GroupDocs.Comparison for Java Blog](https://blog.groupdocs.com/category/groupdocs-comparison-product-family/)
+[Home](https://www.groupdocs.com/) | [Product Page](https://products.groupdocs.com/comparison/java) | [Documentation](https://docs.groupdocs.com/comparison/java/) | [Demos](https://products.groupdocs.app/comparison/family) | [API Reference](https://apireference.groupdocs.com/java/comparison) | [Examples](https://github.com/groupdocs-comparison/GroupDocs.comparison-for-Java/tree/master/Examples) | [Blog](https://blog.groupdocs.com/category/annotation/) | [Free Support](https://forum.groupdocs.com/c/comparison) | [Temporary License](https://purchase.groupdocs.com/temporary-license)