Add README with project description, features, setup, and usage instr…

…uctions

README.md

@@ -0,0 +1,41 @@
+# firefox-bookmark-invalidator
+
+## Description
+
+`firefox-bookmark-invalidator` is a Python script designed to validate and analyze the URLs stored in your Firefox bookmarks. The script processes a JSON file exported from Firefox, checks the validity of each URL, and provides a detailed summary of valid and invalid websites. It also offers insights into the types of protocols and top-level domains used in your bookmarks.
+
+### Features
+
+- **URL Validation**: Tests each URL for accessibility and categorizes them as valid or invalid.
+- **Error Grouping**: Groups invalid URLs by common error types for easier troubleshooting.
+- **Bookmark Analysis**: Provides statistics on protocol handlers, top-level domains, and other interesting metrics.
+- **System Time Check**: Ensures your system clock is synchronized with an NTP server to avoid SSL certificate validation failures due to time discrepancies.
+- **Interactive Display**: Dynamically updates the terminal display with the current status of URL validation.
+
+## Setup
+
+```bash
+pip3 install -r requirements.txt
+```
+
+## Usage
+
+<!-- markdownlint-disable MD033 -->
+
+| First, obtain the bookmarks `json` file from Firefox: |
+|:---:|
+ | <img src="./docs/1.png" alt="First Step" style="display: block; margin: 0 auto;"> |
+ | <img src="./docs/2.png" alt="Second Step" style="display: block; margin: 0 auto;"> |
+ | <img src="./docs/3.png" alt="Third Step" style="display: block; margin: 0 auto;"> |
+
+<!-- markdownlint-enable MD033 -->
+
+Then, run the script:
+
+```bash
+python3 main.py /path/to/bookmarks.json
+```
+
+## Thanks
+
+Special thanks to `Claude 3.5 Sonnet` for the code assistance.