From 14a224fd7660d976e4ef8cc685a6f0390462f816 Mon Sep 17 00:00:00 2001
From: ericj <eric.jaekel@web.de>
Date: Mon, 9 Sep 2024 14:35:52 +0200
Subject: [PATCH] update readme
---
README.md | 44 +++++++++++++++++++-------------------------
1 file changed, 19 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
index 6f7ce52..dcc48df 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,28 @@
-# React + TypeScript + Vite
+# MagicMeal
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-Currently, two official plugins are available:
+## Installation
-- [@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
-## Expanding the ESLint configuration
+- Download project files
+- Install packages:
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+```bash
+npm install
+```
-- Configure the top-level `parserOptions` property like this:
+## Development
+```bash
+npm run dev
+```
-```js
-export default {
- // other rules...
- parserOptions: {
- ecmaVersion: 'latest',
- sourceType: 'module',
- project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'],
- tsconfigRootDir: __dirname,
- },
-}
+## Build
+```bash
+vite build
```
+- The production build is available in the ```dist``` folder
+- Copy the files to your production environment
+
+## Usage
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked`
- or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and
- add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+This website should help you in finding new inspiration for cooking. You are shown a random meal recipe and you can set your meal preferences to vegetarian or vegan. You can also search for specific recipes, save recipes and add or edit your own recipes. Also, you find more details about your cooking habits on the insights screen.
\ No newline at end of file
--
GitLab