Add license, security policy and basic ussage in readme.

Author: adrorocker

.art/domainvalidity.png

@@ -3,16 +3,17 @@
 
 # Exclude unused files
 # see: https://redd.it/2jzp6k
+/.art             export-ignore
 /.github          export-ignore
 /data             export-ignore
 /tests            export-ignore
 /.editorconfig    export-ignore
 /.gitattributes   export-ignore
 /.gitignore       export-ignore
-/phpcs.xml.dist        export-ignore
+/phpcs.xml.dist   export-ignore
 /phpunit.xml      export-ignore
 /phpstan.neon     export-ignore
 /README.md        export-ignore
 
 # Configure diff output for .php files.
-*.php diff=php
+*.php diff=php

.gitattributes

@@ -0,0 +1,19 @@
+Copyright 2023 - 2024 Alejandro Morelos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -1,3 +1,31 @@
+<p align="center">
+    <img src="./.art/domainvalidity.png" width="200">
+</p>
+
 # Doma(in)Validity PHP package.
 
-Light PHP package to validate domains.
+Light PHP package to validate domains.
+
+[Doma(in)Validity](https://api.domainvalidity.dev/) was born because I found myself searching online about how to check if a domain was valid. I always ended up using regular expressions that were too complex to account for several scenarios (mainly the TLD having different formats), it was just a pain in the butt because I always had to go back to that code to fix the regex to account for an edge case that I didn't think about.
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require domainvalidity/php-domain-validator
+```
+
+## Usage
+
+```php
+use DomainValidity\Factory;
+
+$contents = file_get_contents('https://publicsuffix.org/list/public_suffix_list.dat');
+
+$validator = Factory::make($contents);
+
+$host = $validator->validate('www.domainvalidity.dev');
+```
+
+> **Note:** You should cache the contents of the public suffix list and download them no more than once per day, as it is not updated   more than a few times per week; more frequent downloading is pointless.

README.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+**PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, [SEE BELOW](#reporting-a-vulnerability).**
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 2.x     | :white_check_mark: |
+| 1.x     | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability within this package, please send an email to Alejandro Morelos at info@domainvalidity.dev. All security vulnerabilities will be promptly addressed.