diff --git a/README.md b/README.md index 841d69c..f8f6c79 100755 --- a/README.md +++ b/README.md @@ -1,42 +1,47 @@ # GeminiChat: Open-Source Web Interface for Google's Gemini AI -GeminiChat is a user-friendly, open-source web application that allows you to interact with Google's powerful Gemini AI -using your own API key. +**GeminiChat** is an open-source, web-based application that allows you to interact with Google's powerful Gemini AI +seamlessly using your own API key. -## Features +## 🌟 Key Features -- 🚀 Simple setup: Just add your Gemini API key and start chatting -- 💬 Intuitive chat interface for seamless interaction with Gemini AI -- 🔒 Secure: Your API key is stored locally and never shared -- 🎨 Customizable: Easy to modify and adapt to your needs -- 📱 Responsive design: Works on desktop and mobile devices +- 🚀 **Easy Setup**: Just add your Gemini API key and you're ready to start chatting. +- 💬 **Intuitive Interface**: A user-friendly chat interface for smooth interactions with Gemini AI. +- 🔒 **Secure**: Your API key is securely stored locally and never shared. +- 🎨 **Customizable**: Easily tweak the design and functionality to suit your preferences. +- 📱 **Responsive Design**: Optimized for both desktop and mobile devices. -## Getting Started +## 🚀 Getting Started ### Prerequisites -- A Google Gemini API key (Get a free API key here: https://aistudio.google.com/app/apikey) + +- A valid Google Gemini API key. [Get your free API key here](https://aistudio.google.com/app/apikey). +- If you prefer not to install it locally, you can try the chat interface [here](https://eliaspereirah.github.io/GeminiChat/). + +> 🔐 **Note**: Your API key is only sent directly to Google's servers and is not shared elsewhere. ### Installation -1. Clone the repository: - ``` +1. Clone this repository: + ```bash git clone https://github.com/EliasPereirah/GeminiChat.git - cd GeminiChat ``` -2. Open your browser using a localhost server ex: http://localhost/GeminiChat +2. Launch the app using a local server. Example: [http://localhost/GeminiChat](http://localhost/GeminiChat). + +## 🛠️ Usage + +1. Enter your Gemini API key in the provided field. +2. Start chatting with Gemini AI in the main interface. +3. Experience intelligent conversations powered by cutting-edge AI! -## Usage +## 🤝 Contributing -1. Enter your Gemini API key -2. Start chatting with Gemini AI in the main interface -3. Enjoy intelligent conversations and AI-powered assistance! +We welcome contributions! Feel free to fork the repository, make changes, and submit a pull request. Let's improve this project together! -## Contributing +## 📄 License -We welcome contributions! +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. -## License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +## ⚠️ Disclaimer -## Disclaimer -This project is not officially affiliated with or endorsed by Google. Use of the Gemini AI API is subject to Google's terms and conditions. \ No newline at end of file +This project is not affiliated with or officially endorsed by Google. Use of the Gemini AI API is subject to Google's terms and conditions.