Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
KajalDeore04 committed Jan 13, 2025
1 parent e05f580 commit 0474b11
Showing 1 changed file with 8 additions and 20 deletions.
28 changes: 8 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@

# Project Overview
# GEMINI Clone

This project utilizes the Google Generative AI API to create a conversational AI model. The model is based on the Gemini 2.0 Flash Exp model, a state-of-the-art language model capable of generating human-like text.

### Features
- New Chat button to start a new conversation.
- You can move between different conversation.
- Recent conversations are displayes in the sidebar.
- Completely same UI design.

## Getting Started

### Prerequisites
Expand All @@ -14,16 +20,7 @@ This project utilizes the Google Generative AI API to create a conversational AI

1. Clone the repository to your local machine.
2. Install the required dependencies by running `npm install` in the project directory.
3. Replace `Your API Key` with your actual Google Cloud API key in the `index.js` file.

### Usage

1. Import the `run` function in your JavaScript file.
2. Call the `run` function with a prompt as an argument, like this:
```javascript
run("Hello, how are you?");
```
3. The function will return the response from the conversational AI model as a string.
3. Replace `Your API Key` with your actual Google Cloud API key in the `gemini.js` file.

## Configuration

Expand All @@ -45,12 +42,3 @@ The conversational AI model can be configured using the `generationConfig` objec

The `run` function takes a single argument, `prompt`, which is the input text for the conversational AI model. The function returns a promise that resolves to the response from the model as a string.

## Troubleshooting

- Make sure to replace `Your API Key` with your actual Google Cloud API key.
- Check the console output for any error messages.
- Consult the [Google Generative AI API documentation](https://cloud.google.com/generative-ai) for more information on error handling and troubleshooting.

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more information.

0 comments on commit 0474b11

Please sign in to comment.