📦 NEW: Add README and CONTRIBUTING

CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to LangUI
+
+Thank you for considering contributing to LangUI! We appreciate your support in making this open-source Tailwind UI library even better for the AI community. Whether you want to fix a bug, add new components, or improve the documentation, your contributions are valuable to us.
+
+To contribute to LangUI, please follow these guidelines:
+
+## Getting Started
+
+1. **Fork the Repository**: Start by forking the LangUI repository to your GitHub account. This will create a copy of the repository under your account, allowing you to make changes.
+
+2. **Clone the Repository**: Clone the forked repository to your local machine using Git. Use the following command:
+
+   ```bash
+   git clone https://github.com/ahmadbilaldev/LangUI.git
+    ```
+
+3. **Install Dependencies**: Ensure you have Node.js and npm installed. Run the following command in the project directory to install the required dependencies:
+
+    ```bash
+    npm install
+    ```
+
+4. **Run the Server**: Run the local server using:
+
+    ```bash
+    npm run dev
+    ```
+
+## Making changes
+
+1. **Create a Branch**: Before making any changes, create a new branch where you will work on your contribution. Use a descriptive and relevant name for your branch:
+
+    ```bash
+    git checkout -b your-branch-name
+    ```
+
+2. **Make Changes**: Implement your changes, whether it's adding new components, fixing bugs, or improving existing code. All LangUI components go in the `public/components` directory.
+
+3. **Build your Component's CSS**: If you are building or making changes to a component, you will have to run the following command to build its CSS:
+
+    ```bash
+    npm run css:components
+    ```
+
+4. **Test Your Changes**: Before submitting a pull request, ensure that your changes work as intended. Run tests if available and test the components in different viewports and modes.
+
+5. **Commit and Push**: Once you are satisfied with your changes, commit them using descriptive commit messages.
+
+## Submitting a Pull Request
+
+1. **Create Pull Request**: Go to your forked repository on GitHub and click on the "New Pull Request" button. Compare your branch with the main branch of the original repository.
+
+2. **Describe Your Changes**: Provide a clear and concise description of your changes in the pull request. Include any relevant information that helps reviewers understand your contribution.
+
+3. **Review Process**: The maintainers of LangUI will review your pull request. Be prepared for feedback and make any necessary adjustments based on the review.
+
+4. **Merge**: Once your pull request is approved, it will be merged into the main branch, and your changes will be part of LangUI!
+
+## License
+
+By contributing to LangUI, you agree that your contributions will be licensed under the [MIT License](LICENSE).
+
+Thank you for contributing to LangUI! We greatly appreciate your efforts to make this library even more valuable to the AI community. If you have any questions or need assistance, feel free to open an issue or reach out to the maintainers.
+
+Happy contributing! 😊

README.md

@@ -1,9 +1,61 @@
-# GPT UI
+<div align="center">
+  <img src="./public/logo.png" alt="LangUI Logo">
+</div>
 
-Beautiful hand crafted Tailwind components for your GPT, generative AI, and LLM projects.
+<h3 align="center">The perfect UI for your AI</h3>
 
-GPT UI is an Open Source Tailwind library with free to use components tailored for your AI and GPT projects. Focus on building the next best project and let it handle the UI.
+<p align="center">
+  <a href="https://github.com/ahmadbilaldev/LangUI/stargazers">
+    <img src="https://img.shields.io/github/stars/ahmadbilaldev/LangUI.svg" alt="GitHub Stars">
+  </a>
+  <a href="https://opensource.org/licenses/MIT">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
+  </a>
+</p>
+<hr/>
 
-## How to contribute?
+LangUI is an Open Source Tailwind library with free components tailored for your AI and GPT projects. It offers a collection of beautiful, ready-to-use components to enhance the user interface of your AI applications, allowing you to focus on building the next best project while leaving the UI to LangUI.
 
-Create an issue for suggestions and requests. Contributions are also welcome.
+## Documentation
+
+For documentation and components, visit [LangUI.dev](https://www.langui.dev/).
+
+## Get Started
+
+- LangUI components are ready-to-use, meaning you don't need to install or configure anything.
+
+- Browse [LangUI.dev](https://www.langui.dev/) and select a comopnent.
+
+- Copy the desired component's code in HTML or JSX from the LangUI documentation.
+
+- Paste the code into your project's HTML or React/Vue/Angular components. Done.
+
+## Features
+
+- **Copy & Paste Integration**: Zero installations or dependencies! Simply choose your desired component, copy, and paste it into your project.
+
+- **Open Source & Free**: LangUI is MIT licensed, making it suitable for both personal and commercial projects. Feel free to contribute and support us by starring LangUI on GitHub.
+
+- **Dark & Light Modes**: All LangUI components support light & dark modes and are carefully designed to look the best across both modes.
+
+- **Fully Responsive**: LangUI components are responsive, ensuring they look fantastic on any screen size or device.
+
+- **Easy Customization**: LangUI uses a two-color-only pallete. The two color pallete - slate and blue - allows for effortless customization into your brand's colors.
+
+## Request a Component
+
+Have an idea for a new component? We'd love to hear from you! Simply head over to our [GitHub repository](https://github.com/ahmadbilaldev/LangUI) and submit your component request. Let's collaborate and cook up something spicy together!
+
+## Contributing
+
+Contributions to LangUI are highly welcome! Whether it's bug fixes, new components, or improvements, we appreciate your support in making this library better for the AI community. Please read our [contribution guidelines](CONTRIBUTING.md) to get started.
+
+## License
+
+LangUI is licensed under the [MIT License](LICENSE).
+
+---
+
+Enjoy using LangUI to build stunning UIs for your AI and GPT projects. If you find it helpful, don't forget to give it a star on GitHub! For any queries or issues, feel free to open an [issue](https://github.com/ahmadbilaldev/LangUI/issues) on the repository.
+
+Happy coding! 😊