Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
vwh authored Aug 26, 2024
1 parent 42e37ab commit 051b2d2
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<h1>ReVite</h1>
<div align="center">
<h1>ReVite</h1>
</div>

<p align="center">
Expand All @@ -18,10 +18,12 @@
<br>

<div align="center">
<img src="https://github.com/user-attachments/assets/9ab15a1e-aa04-4813-8b5c-ca75b72afa43" alt="Preview">
<a href="https://github.com/vwh/revite" target="_blank">
<img src="https://github.com/user-attachments/assets/9ab15a1e-aa04-4813-8b5c-ca75b72afa43" alt="Preview">
</a>
</div>

## Project Structure
## 🗃️ Project Structure

```bash
ReVite/
Expand All @@ -47,9 +49,9 @@ ReVite/
└── vite.config.ts # Vite configuration
```

## Getting Started
## 🚀 Getting Started

### Installation
### 📥 Installation

Clone the repository and install dependencies:

Expand All @@ -59,39 +61,39 @@ cd revite
npm install
```

### Development Server
### 💻 Development Server

Start the development server:

```bash
npm run dev
```

### Build
### 🏗️ Build

Build the project for production:

```bash
npm run build
```

### Preview
### 👀 Preview

Preview the production build locally:

```bash
npm run preview
```

### Linting
### 🧹 Linting

Lint the project files:

```bash
npm run lint
```

### Formatting
### 🎨 Formatting

Format the project files:

Expand All @@ -105,6 +107,6 @@ Check the formatting:
npm run format:check
```

## Contributing
## 🤝 Contributing

Contributions are welcome! Fork the repository, create your feature branch, commit your changes, and submit a pull request.
Contributions are welcome! Feel free to open a pull request with your improvements or fixes.

0 comments on commit 051b2d2

Please sign in to comment.