docs: document report formats and CSV header-only behavior

[kavya-seth-vns]

📖 Documentation Update: Report Formats

✨ Summary

This pull request improves the README by documenting DockSec's supported report formats in a dedicated Report Formats section.

✅ What's Included

• Added a dedicated Report Formats section to the README.
• Documented the supported output formats:
  • JSON – Machine-readable output for automation.
  • CSV – Tabular output for spreadsheets and reporting.
  • PDF – Human-readable report for sharing.
  • HTML – Interactive browser-based report.
• Clarified the expected header-only CSV behavior when no findings are present.
• Added references to the existing Machine-readable Output and SARIF Output sections instead of duplicating information.
• Maintained consistency with the existing README structure and writing style.

---

📝 Type of Change

• Documentation update

---

✅ Testing

• Verified Markdown formatting renders correctly.
• Verified internal links and section references.
• Reviewed for grammar, consistency, and readability.

Environment

• Operating System: Windows 11
• Python Version: N/A
• DockSec Version: Current main branch

---

✔️ Checklist

• Documentation updated
• Self-review completed
• No warnings or errors introduced
• Spelling and formatting checked
• Follows the project's documentation style

---

Closes #132

Thank you for reviewing this contribution! 🚀

[advaitpatel]

@kavya-seth-vns thank you for your PR however some other contributor has made the same changes. Could you please find any other issue and raise your PR again? Thank you!

[kavya-seth-vns]

@advaitpatel
Thank you for the clarification! I appreciate your feedback.

I'll look for another issue and submit a new PR soon.

Thanks!

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.51%. Comparing base (a2fe184) to head (7ca97f4).
⚠️ Report is 33 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #135      +/-   ##
==========================================
+ Coverage   78.95%   80.51%   +1.56%     
==========================================
  Files          26       32       +6     
  Lines        4158     5169    +1011     
==========================================
+ Hits         3283     4162     +879     
- Misses        875     1007     +132     

Flag	Coverage Δ
unittests	80.51% <ø> (+1.56%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[advaitpatel]

lgtm