Update README for ixdiagnose

README.md

@@ -1 +1,54 @@
-# ixdiagnose
+<p align="center">
+      <a href="https://discord.gg/Q3St5fPETd"><img alt="Join Discord" src="https://badgen.net/discord/members/Q3St5fPETd/?icon=discord&label=Join%20the%20TrueNAS%20Community" /></a>
+ <a href="https://www.truenas.com/community/"><img alt="Join Forums" src="https://badgen.net/badge/Forums/Post%20Now//purple" /></a> 
+ <a href="https://jira.ixsystems.com"><img alt="File Issue" src="https://badgen.net/badge/Jira/File%20Issue//red?icon=jira" /></a>
+</p>
+
+TrueNAS iXdiagnose main source repo
+=============
+
+Welcome to the TrueNAS `iXdiagnose` repository!
+
+This open-source project provides a comprehensive set of tools and scripts designed to generate detailed debugging information for the TrueNAS system.
+
+## Usage
+
+**Step 1:**
+Clone the **iXdiagnose** repository:
+```bash
+git clone https://github.com/truenas/ixdiagnose.git
+```
+
+**Step 2:**
+Navigate to **iXdiagnose** directory. for example:
+```bash
+cd path/to/ixdiagnose
+```
+
+**Step 3:**
+Install dependencies:
+```bash
+pip install -r requirements.txt
+```
+
+**Step 4:**
+Install the **iXdiagnose**:
+
+```bash
+python setup.py install
+```
+
+**step 5:**
+You can run it and generate debug using the following command:
+```bash
+ixdiagnose run --debug-path="specify/path/to/debug"
+```
+
+iXdiagnose is well-documented for all its features. For any specific details please move to the [iXdiagnose docs](https://github.com/truenas/ixdiagnose/blob/master/docs/).
+
+## Contributing
+
+Contributions to ixdiagnose are encouraged!
+
+If you come across any challenges or have suggestions for improvements, please don't hesitate to open an issue on [iXsystems Jira](https://ixsystems.atlassian.net/jira/software/c/projects/NAS/issues/?filter=allissues).
+Additionally, we warmly welcome Pull Requests for further contributions.