add readme

Nikolaus-B · Mar 24, 2024 · 1fa502c · 1fa502c
1 parent e7971dc
commit 1fa502c
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,22 @@
-# React + Vite
+# Campers
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+Campers is a web application designed to facilitate the search for rental vehicles. It allows users to easily find and rent campervans for their adventures. With Campers, users can browse through a wide selection of vehicles, apply various filters to refine their search, and add their favorite vehicles to their favorites list.
 
-Currently, two official plugins are available:
+# Features
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+Vehicle Rental: Users can browse through a diverse range of campervans available for rent.
+Filtering Options: Campers offers advanced filtering options, allowing users to find vehicles based on specific criteria such as location, vehicle type, and equipment.
+Favorites: Users can mark their favorite vehicles and access them later in their favorites list.
+Technologies Used
+Campers is built using modern web technologies, ensuring a seamless user experience.
+
+# Frontend:
+
+Developed with React, providing a dynamic and interactive user interface.
+State Management:
+Redux is utilized for efficient state management, ensuring data consistency across the application.
+Build Tool: Vite was used as the build tool for quick development and optimized builds.
+
+# Backend
+
+The backend for Campers is powered by a mock API, which was created to simulate data retrieval and storage operations. This allows seamless integration with the frontend while focusing on development and testing.
diff --git a/index.html b/index.html
@@ -1,10 +1,10 @@
-<!doctype html>
+<!DOCTYPE html>
 <html lang="en">
  <head>
  <meta charset="UTF-8" />
  <link rel="icon" type="image/svg+xml" href="/vite.svg" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <title>Vite + React</title>
+ <title>Campers</title>
  </head>
  <body>
  <div id="root"></div>