From 93af6e6e6e398c4103469a186507a9b191049b80 Mon Sep 17 00:00:00 2001 From: lakshmirajvagu Date: Wed, 16 Oct 2024 13:58:57 +0530 Subject: [PATCH 1/2] Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 6f1dcf4..bda2966 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,25 @@ Welcome to **GlassyUI-Components**! This open-source library features stunning React components designed with a captivating glassmorphism effect, perfect for giving your web applications a modern and sleek design. +## 📚 Table of Contents + +- [Project Overview](#project-overview) +- [Features](#features) +- [Components](#components) +- [Tech Stack](#tech-stack) +- [Installation](#installation) +- [Changelog](#changelog) +- [Future Enhancements / Roadmap](#future-enhancements--roadmap) +- [Contributing](#contributing) +- [Pull Request Guidelines](#pull-request-guidelines) +- [Code of Conduct](#code-of-conduct) +- [Our Contributors](#our-contributors) + +## Project Overview + +This open-source library features stunning React components designed with a captivating glassmorphism effect, perfect for giving your web applications a modern and sleek design. + + ## ✨ Features - Glassmorphism-themed React components @@ -20,6 +39,14 @@ Welcome to **GlassyUI-Components**! This open-source library features stunning R - **Modals:** Elegant modals featuring the glassmorphism effect. - **Navigation Bar:** Modern navigation bars with a glassy theme. +## 🛠️ Tech Stack + +- **React**: JavaScript library for building user interfaces. +- **SCSS**: A CSS preprocessor for more manageable styles. +- **Docker**: For containerization and easy deployment. +- **Node.js**: JavaScript runtime for server-side development. + + ## 🖥️ Website Preview ![Home Page](https://github.com/user-attachments/assets/f6f73936-ca0d-4232-a646-67189f5aa901) @@ -152,6 +179,11 @@ git push origin my-feature-branch -If more than 1 week issue is not resolved then it will be assigned to someone else. +### Code of conduct: +- This README structure includes all the sections you wanted. +- Adjust the contributors section as needed based on your actual contributors. +- Feel free to add or modify any content to better fit your project’s specific needs! + ## Our Contributors - We truly appreciate your incredible contributions to this project! Your dedication and hard work are vital to its continued growth and success. If you’ve found value in it, don’t forget to show your support by giving our repository a star! ⭐ From 9a0d4eccb6bfbf06eb2bd0cdb6b14d4106a93ac2 Mon Sep 17 00:00:00 2001 From: lakshmirajvagu Date: Wed, 16 Oct 2024 14:13:03 +0530 Subject: [PATCH 2/2] Update README.md added table of contents and some additional conents like tech stack and code of conduct etc --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bda2966..1cfbd24 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,18 @@ Welcome to **GlassyUI-Components**! This open-source library features stunning R ## 📚 Table of Contents - [Project Overview](#project-overview) -- [Features](#features) +- [Features](#Features) - [Components](#components) - [Tech Stack](#tech-stack) -- [Installation](#installation) -- [Changelog](#changelog) +- [Website Preview](#WebsitePreview) +- [Prerequisites](#Prerequisites) +- [Installation with docker](#Installationwithdocker) +- [Installation without docker](#Installationwithoutdocker) +- [Changelog](#Changelog) +- [Usage](#Usage) - [Future Enhancements / Roadmap](#future-enhancements--roadmap) - [Contributing](#contributing) -- [Pull Request Guidelines](#pull-request-guidelines) +- [Contribution Rule](#ContributionRule) - [Code of Conduct](#code-of-conduct) - [Our Contributors](#our-contributors)