reviewIt README

This is the README for the "reviewIt" extension, your AI-powered assistant for code reviews within VSCode. Leverage the cutting-edge capabilities of OpenAI directly in your editor to enhance code quality, adhere to best practices, and learn on the go.

Features

"reviewIt" integrates OpenAI's GPT models to provide real-time code reviews, actionable suggestions, and coding best practices. Whether you're writing JavaScript, Python, or any other supported language, "reviewIt" is here to guide you towards better coding standards.

• Real-Time Code Reviews: Select a block of code and receive instant feedback.
• Actionable Suggestions: Get specific advice on how to improve your code.
• Seamless Integration: Works within your VSCode environment without disrupting your workflow.

Tip: For an effective demonstration, consider creating short, focused animations that showcase your extension in action.

Requirements

To use "reviewIt", you'll need:

• An active internet connection.
• An OpenAI API key, which you can obtain here.

Extension Settings

"reviewIt" adds the following settings for customization and control:

• `reviewit.apiKey`: Your OpenAI API key for enabling the code review features.

To set your OpenAI API key in VSCode, go to `Settings > Extensions > reviewIt` and enter your key in the `API Key` field.

Known Issues

No known issues at this time. For any bugs or unexpected behavior, please open an issue on the GitHub repository.

Release Notes

Users appreciate detailed release notes as you update your extension.

1.0.0

Initial release of reviewIt:

• Basic code review capabilities.
• Integration with OpenAI GPT models.

1.0.1

• Improved error handling.
• Enhanced feedback specificity.

1.1.0

• Added support for multiple programming languages.
• Introduced customizable review intensity settings.

---

GitHub Repository

For more information, to contribute, or to report issues, please visit our GitHub repository.

Following Extension Guidelines

Ensure to read through and follow the best practices as outlined in the Extension Guidelines.

Working with Markdown in VSCode

VSCode provides excellent support for Markdown editing, with useful shortcuts and preview options:

• Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
• Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
• Use `Ctrl+Space` (Windows, Linux, macOS) for a list of Markdown snippets.

For more detailed information on working with Markdown in VSCode, refer to:

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy coding with reviewIt, your AI-powered code review companion! EOF