Merge pull request #12 from olasunkanmi-SE/olasunkanmi-SE-patch-2

Update README.md

README.md

@@ -1,6 +1,8 @@
-# codebuddy
+# CodeBuddy - AI-Powered Coding Assistant
 
-This extension for Visual Studio Code provides a generative AI assistant that can help generate code, complete tasks, and assist you in your development workflow. The assistant is powered by a machine learning model that can understand and respond to natural language input, allowing you to interact with it as you would with a human assistant.
+CodeBuddy is a Visual Studio Code extension that provides an AI-powered coding assistant to help developers write better code more efficiently. With CodeBuddy, you can get intelligent code suggestions, completions, and assistance based on the context and requirements of your code.
+
+This is your Free version of Copilot. All you need is a gmail account. Sign up to Google Gemini, grab your API key.
 
 ## Features
 
@@ -10,3 +12,57 @@ This extension for Visual Studio Code provides a generative AI assistant that ca
 - Code analysis: The assistant can analyze your code and provide suggestions for improvement, such as pointing out potential bugs, security vulnerabilities, and performance issues.
 - Code formatting: The assistant can format your code to conform to your preferred style guide, making your code more readable and maintainable.
 - Code search: The assistant can search for code snippets and functions within your codebase, allowing you to quickly find and reuse existing code.
+
+
+## Installation
+
+1. Open Visual Studio Code.
+2. Go to the Extensions view by clicking on the square icon in the Activity Bar on the side of the window.
+3. Search for "CodeBuddy" in the Extensions view.
+4. Click on the "Install" button next to the CodeBuddy extension.
+5. Once the installation is complete, you will see the CodeBuddy icon in the Explorer Bar.
+
+## Usage
+
+1. Open a code file in Visual Studio Code.
+2. Click on the CodeBuddy icon in the Activity Bar to open the CodeBuddy view.
+3. Start typing your code or describe the problem you're working on in the chat interface.
+4. CodeBuddy will analyze your code and provide intelligent suggestions, completions, and assistance based on the context.
+5. You can interact with CodeBuddy through the chat interface or within your workspace to get explanations, clarify requirements, or iterate on the generated code suggestions.
+6. CodeBuddy will adapt its suggestions and explanations based on the programming language, framework, or library you are using.
+
+## Configuration
+
+CodeBuddy provides the following configuration options:
+
+- `codebuddy.apiKey`: Set your Google Generative AI API key to enable the AI functionality.
+- `codebuddy.model`: Specify the AI model to use for code assistance (default: "gemini-1.0-pro-latest").
+
+To configure these options, go to the Visual Studio Code settings and search for "CodeBuddy".
+
+## Requirements
+
+- A Google Generative AI API key to enable the AI functionality.
+- Latest version of Vscode
+
+## Extension Settings
+
+- Presently supports Google Gemini.
+- In vscode settings, search for Ola, and under extensions, click on 'Your coding buddy'. 
+- Enter your Google Gemini API key and Gemini Model
+- Or in the settings.json file, enter this   
+- "google.gemini.apiKey": "Your API key",
+- "google.gemini.model": "models/gemini model",
+
+## Release Notes
+
+### 1.0.0
+
+- Initial release of CodeBuddy.
+
+## Contributing
+- Note that this is an inital version and there are alot of improvements that will be done in future releases
+- Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.
+
+
+Enjoy coding with CodeBuddy!