From 1f0eb90a322a4be0ed78d813050b097b11c2d52e Mon Sep 17 00:00:00 2001
From: Povl Filip Sonne-Frederiksen <pfs@linkarkitektur.dk>
Date: Mon, 6 Mar 2023 13:45:20 +0100
Subject: [PATCH] Updated README

---
 README.md | 24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index b3696b7..dc51d30 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,17 @@
 # Speckle LCA
 
+SpeckleLCA is a web app that connects to [Speckle](https://speckle.systems/) and allows for a simple forkflow to calculate LCA results for early phase design projects.
+The app is still in development and support [One Click LCA](https://www.oneclicklca.com/) as well as [LCAbyg](https://lcabyg.dk/en/) for now.
 
-## How to run
-To run app you need
-[Node.js](https://nodejs.org/en/)
-Visualstudio code or something similar
 
-Then in visualstudio code run `npm ci`
-Put `.env.local` file in the root folder of the application
+
+
+## How to run it
+To run the app you will need:
+ - [Node.js](https://nodejs.org/en/)
+ - [VSCode](https://code.visualstudio.com/) or something similar text editor ([Neovim](https://neovim.io/) :wink:)
+ - Set the following enviroment variables\
+The easiest way is to put them in a `.env.local` file in the root folder off the project.
 
 ```
 VUE_APP_SPECKLE_ID=CHANGE
@@ -15,6 +19,14 @@ VUE_APP_SPECKLE_SECRET=CHANGE
 VUE_APP_SERVER_URL=https://speckle.xyz
 VUE_APP_SPECKLE_NAME="Speckle LCA"
 ```
+ - Then run `npm ci` in VSCode or a different terminal\
+ To download and install the required modules.
+ - `npm run serve` Finally launches the app.
+ 
+The `VUE_APP_SPECKLE_ID` & `VUE_APP_SPECKLE_SECRET` values can be genereated by to Prifile -> Developer Settings -> Aæælications on Speckle and creating a new entry.
+
+ ## Usage
+
 
 Login to speckle and add app under your account a new application you will get a application ID and a secret ID add thiese to `.env.local`.