Enhance README for Clarity and Comprehensive Guidance

README.md

@@ -1,12 +1,99 @@
-[![Build Status](https://travis-ci.org/renyard/validity.svg?branch=develop)](https://travis-ci.org/renyard/validity)
-[![Code Climate](https://codeclimate.com/github/renyard/validity/badges/gpa.svg)](https://codeclimate.com/github/renyard/validity)
-[![Test Coverage](https://codeclimate.com/github/renyard/validity/badges/coverage.svg)](https://codeclimate.com/github/renyard/validity/coverage)
 
-# Validity
+  
 
+# Validity - HTML Document Validator README
 
-Validity can be used to quickly validate your HTML documents from the address bar.
+  
 
-Just click the icon in the address bar to validate the current document without leaving the page.  The number of validation errors can be seen in the tool tip and the detail can be seen in the Javascript console.
+## Introduction
 
-Validity also gives you the option to use your own installation of the W3C Validation Service.  (For more information on installing the W3C Validation Service see the documentation at [http://validator.w3.org/docs/install.html](http://validator.w3.org/docs/install.html)).
+
+
+Validity is a robust tool designed for web developers and designers to validate HTML documents directly from the browser's address bar. It simplifies identifying and correcting validation errors, offering a quick view of errors through the browser's tooltip and detailed reports in the JavaScript console.
+
+
+
+## Features
+
+
+
+-  **Instant Validation**: Quickly validate HTML documents without leaving the page.
+
+-  **Error Reporting**: See the number of validation errors directly in the tooltip and detailed information in the JavaScript console.
+
+-  **Custom Validation Service**: Option to use a personal installation of the W3C Validation Service for enhanced control.
+
+
+
+## Installation
+
+
+
+### Chrome Extension Installation Guide
+
+
+
+To install the Validity Chrome Extension:
+
+1. Visit the [Chrome Web Store](https://chromewebstore.google.com/detail/validity/bbicmjjbohdfglopkidebfccilipgeif).
+
+2. Click on "Add to Chrome" to install the extension.
+
+3. Once installed, the Validity icon will appear in your browser's address bar, ready to validate HTML documents with a single click.
+
+
+
+### W3C Markup Validator Installation Guide Overview
+
+
+
+The W3C Markup Validator installation is intended for users preferring to use their own validation service. Key steps include:
+
+- Ensuring prerequisites such as a web server and Perl are met.
+
+- Installing OpenSP, the SGML and XML parser.
+
+- Installing necessary Perl Modules, either through CPAN or individually.
+
+- Downloading, unpacking, and configuring the validator from the GitHub repository.
+
+- Configuring your web server to serve the validator, typically with Apache.
+
+- Testing the installation to ensure it operates correctly.
+
+
+
+For detailed installation instructions, refer to the [official documentation](http://validator.w3.org/docs/install.html).
+
+
+
+## How to Contribute
+
+
+
+Contributing to Validity is straightforward:
+
+1.  **Clone the Repository**: Fork the repository on GitHub and clone it to your local machine.
+
+2.  **Make Changes**: Apply your fixes or enhancements.
+
+3.  **Submit a Pull Request**: Push your changes back to your fork and submit a pull request to the main repository, detailing your modifications.
+
+
+
+Check the [project's issues](https://github.com/renyard/validity/issues) on GitHub to see what needs contributing.
+
+
+
+## Links
+
+
+
+- Issues and How to Contribute: [GitHub Issues](https://github.com/renyard/validity/issues)
+
+- Chrome Extension: [Download Here](https://chromewebstore.google.com/detail/validity/bbicmjjbohdfglopkidebfccilipgeif)
+
+
+## License
+
+Validity is licensed under the Apache License, Version 2.0. For more details, see [LICENSE](./LICENSE).