Update README.md

README.md

@@ -1,8 +1,35 @@
-# Nuxt 3 Minimal Starter
 
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+# Mushroom DB Admin App
 
-## Setup
+This project was the result of a Capstone Project run through Massey University. It is a webapp designed using NuxtJS to easily identify the different variety of mushrooms and fungi that grow in Aotearoa New Zealand.
+
+This is a companion app to the main app in the following repository: https://github.com/kloudsoft91/mushroom_db_app.git
+
+
+## Authors
+
+-
+-
+- Joel Yap, ID: 21007112
+- Emily Ferguson, ID: 21013503
+- Karan Nayak, ID: 21002217
+
+
+## Run Locally
+
+Clone the project
+
+```bash
+  git clone https://github.com/kloudsoft91/mushroom_db_app_admin_gui.git
+```
+
+Go to the project directory
+
+```bash
+  cd mushroom_db_app_admin_gui
+```
+
+### Setup
 
 Make sure to install the dependencies:
 
@@ -17,7 +44,7 @@ pnpm install
 yarn install
 ```
 
-## Development Server
+### Development Server
 
 Start the development server on `http://localhost:3000`:
 
@@ -32,19 +59,19 @@ pnpm run dev
 yarn dev
 ```
 
-## Production
+### Production
 
 Build the application for production:
 
 ```bash
 # npm
-npm run build
+npm run generate
 
 # pnpm
-pnpm run build
+pnpm run generate
 
 # yarn
-yarn build
+yarn generate
 ```
 
 Locally preview production build:
@@ -60,4 +87,10 @@ pnpm run preview
 yarn preview
 ```
 
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+## Deploy to Production
+
+To deploy to production, run the following command (you need access to this repository):
+
+```bash
+  npm run deploy
+```