Skip to content

Enhance README with detailed sections and add a screenshot#43

Merged
brandochn merged 1 commit intomainfrom
improve-readme-file
Mar 22, 2026
Merged

Enhance README with detailed sections and add a screenshot#43
brandochn merged 1 commit intomainfrom
improve-readme-file

Conversation

@brandochn
Copy link
Copy Markdown
Owner

This pull request significantly enhances the README.md to provide a more comprehensive and user-friendly overview of the Light Query Profiler project. The documentation now covers both the desktop application and the new Visual Studio Code extension, details key features, and improves onboarding instructions for users and contributors.

Documentation improvements:

  • Expanded the project introduction to clarify that Light Query Profiler is available both as a desktop app and a VS Code extension, with updated badges and links to the VS Code Marketplace.
  • Added detailed sections for Features, Requirements, Authentication Modes, Supported Platforms, and Known Issues to better inform users about capabilities and limitations.
  • Included step-by-step instructions for installing and using the VS Code extension.

Contribution and project status:

  • Added a Contributing section with clear steps for submitting changes, and updated the Status section for clarity.

Formatting and visuals:

  • Improved formatting, added a screenshot, and reorganized the Table of Contents for easier navigation.

@brandochn brandochn merged commit 5c7ceaf into main Mar 22, 2026
1 check passed
@brandochn brandochn deleted the improve-readme-file branch March 22, 2026 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant