Skip to content

Conversation

@nickyzero
Copy link
Contributor

@nickyzero nickyzero commented Jan 26, 2026

Description

This pull request updates the readme.md to improve clarity, and provide more accurate examples for users.

Key changes:

  • Corrects the descriptions for image alt text.
  • Updates the table of contents to include additional examples.
  • Improves the installation guide with better formatting and syntax highlighting.
  • Enhances command-line examples with bash syntax highlighting and clearer instructions, especially for the -e exclude option.
  • Refines the result and Docker sections for better readability.
  • Fixes various minor formatting issues and removes trailing whitespace.

Type of change

Please insert 'x' one of the type of change.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation update
  • Refactoring, Maintenance
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

@dd-jy dd-jy added the documentation [PR/Issue] Improvements or additions to documentation label Jan 26, 2026
@dd-jy dd-jy merged commit 16576a3 into fosslight:main Jan 26, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation [PR/Issue] Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants