search

atenreiro / opensquat

The openSquat is an open-source tool for detecting domain look-alikes by searching for newly registered domains that might be impersonating legit domains and brands.
https://opensquat.com
GNU General Public License v3.0
685 stars 130 forks source link

Updated README file with Table of Contents and How to Contribute Section #95

Closed KellyLTran closed 7 months ago

KellyLTran commented 7 months ago

This pull request updates the README file of the openSquat project to improve its structure and clarity. The specific additions include:

  1. A Table of Contents: To make the README file more organized and user-friendly, a table of contents has been added. This table provides quick links to important sections, such as update instructions and usage examples. The purpose is to enhance the overall readability and accessibility of the detailed document.
  2. A "How to Contribute" Section: Since community contributions are important for open-source projects, a new section detailing the process of contributing to openSquat has been added. This section outlines the steps and guidelines for contributors, such as how to report bugs and how to make code contributions. The purpose is to encourage and facilitate community involvement in the development of openSquat.

These updates are intended to help both current users and potential contributors navigate the README file and make encouraged contributions.