Revise README for Vue Navbar Component
Updated README to reflect the Vue Navbar component details, features, tech stack, and getting started instructions.
This commit is contained in:
42
README.md
42
README.md
@@ -1,5 +1,41 @@
|
||||
# Vue 3 + TypeScript + Vite
|
||||
# Vue Navbar Component
|
||||
|
||||
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
|
||||
A modern, minimal **Navbar component** built with **Vue 3**, **TailWindCss**, and **Vite**.
|
||||
This project was created as a hands-on UI experiment, inspired by the navigation design and interaction patterns used in **Coda**.
|
||||
|
||||
The focus is on:
|
||||
- clarity over complexity
|
||||
- smooth interactions
|
||||
- clean internal structure
|
||||
|
||||
---
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- ⚡ Built with **Vue 3 Composition API**
|
||||
- 🎨 Clean, modern UI inspired by **Coda**
|
||||
- 🛠 Powered by **Vite** for fast development
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 📦 Tech Stack
|
||||
|
||||
- **Vue 3**
|
||||
- **TypeScript**
|
||||
- **Vite**
|
||||
- (Optional styling: Tailwind / custom CSS depending on your setup)
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ghaemaghaey/vue-Navbar.git
|
||||
cd vue-Navbar
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
## Screen Shot
|
||||
<img width="1904" height="279" alt="image" src="https://github.com/user-attachments/assets/15b85439-877c-4ed2-ad8f-37055a87c8eb" />
|
||||
|
||||
Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
|
||||
|
||||
Reference in New Issue
Block a user