From a9f70ab2aca6cfdb2069065f57c24067fda214a1 Mon Sep 17 00:00:00 2001 From: VectorGits Date: Mon, 25 Mar 2024 14:38:30 +0100 Subject: [PATCH 1/2] Update README.md with project information and contribution guidelines --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index be15774..d19f17e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,15 @@ # W3C validator for Holberton School -For HTML, CSS and SVG files +> This program is designed to validate `.HTML`, `.CSS`, and `.SVG` files. It checks these files for compliance with [W3C](https://www.w3.org/) standards, helping to ensure that your web content is accessible, reliable, and follows established web standards. This is crucial for maintaining compatibility across various web browsers and platforms. By using this program, developers can catch and fix errors early in the development process, improving the quality of their code and potentially saving time and resources. -Based on 1 API: +## Table of Contents + - [Requirements](#requirements) + - [Usage](#quickstart) + - [Troubleshooting](#troubleshooting) + - [Contributing](#contributing) + +--- + +#### Based on 1 API: - [Markup Validator Web Service API](https://validator.w3.org/docs/api.html) ## Requirements @@ -52,3 +60,14 @@ python3 -m pip install requests ``` If you don't have `pip` installed, you can get it [here](https://pypi.org/project/pip/). + +## Contributing + +To contribute to this project, follow these steps: + * Fork this repository. + * Create a branch: `git checkout -b `. + * Make your changes and commit them: `git commit -m ''`. + * Push to the original branch: `git push` + * Create the pull request. + +Alternatively see the Github documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). \ No newline at end of file From 23ba6005143c227ce646c4e5e0f1c253c80d12c3 Mon Sep 17 00:00:00 2001 From: VectorGits Date: Mon, 25 Mar 2024 14:43:18 +0100 Subject: [PATCH 2/2] Fixed typo in nav tree --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d19f17e..15d3c20 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ## Table of Contents - [Requirements](#requirements) - - [Usage](#quickstart) + - [Quickstart](#quickstart) - [Troubleshooting](#troubleshooting) - [Contributing](#contributing)