added README

README.md

@@ -1,30 +1,21 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@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
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-export default {
-  // other rules...
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-  },
-}
-```
-
-- 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
+# My portfolio website
+
+## Table of Contents
+- [My portfolio website](#my-portfolio-website)
+  - [Table of Contents](#table-of-contents)
+  - [Description](#description)
+  - [Installation](#installation)
+
+## Description
+I created my portfolio website with Vite, React, and TypeScript and uses the React-Bootstrap library for styling. The website is a single-page application that showcases my projects, skills, and contact information. The website is responsive and can be viewed on mobile devices as well as desktops.
+
+The website is hosted on GitHub Pages and can be accessed [here](https://www.sirrenberg.net/).
+
+## Installation
+1. Clone the repository with `git clone [email protected]:sirrenberg/sirrenberg.github.io.git`
+2. move into the directory with `cd sirrenberg.github.io`
+3. Make sure you have the latest version of npm and vite installed
+   - check your version of npm with `npm -v` which should be at least 10.5.0
+   - run `npm install -g npm@latest` to update npm if necessary
+4. run `npm install` to install the dependencies
+5. run `npm run dev` to start the development server