From 61453fcefa70f001635ee3e7d99e4c69c34afc26 Mon Sep 17 00:00:00 2001
From: Martin <901824+martinstark@users.noreply.github.com>
Date: Mon, 15 Apr 2024 11:38:27 +0200
Subject: [PATCH] chore: update readme

---
 README.md | 35 +++++++----------------------------
 1 file changed, 7 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index edaea0d3..71541ff8 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,13 @@
-# React + TypeScript + Vite
+# Intercom Frontend
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+User interface for web based intercom solution.
 
-Currently, two official plugins are available:
+## Get Started
 
-- [@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
+Pre-requisites: Node v20, yarn
 
-## Expanding the ESLint configuration
+`yarn` to install packages
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+`cp .env.local.sample .env.local` to set up local environment (do not skip!)
 
-- 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
-
-## Example .env.local file
-
-Replace sample with actual values
+`yarn dev` to start a dev server