From 6b1103d4a198a0e687e35529e74b157971457e93 Mon Sep 17 00:00:00 2001
From: raythompsonwebdev <raymond.thompson@raythompsonwebdev.co.uk>
Date: Sat, 20 Jan 2024 20:55:02 +0000
Subject: [PATCH] update read me

---
 README.md | 55 ++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 36 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 91edf79..c34ec8b 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ![shoestore](/www-shoestore-home-page-large.jpg)
 
-# Description
+## Description
 
 Ecommerce Web application based on photoshop website template design downloaded from website [php.jabber.com](https://www.phpjabbers.com/).
 
@@ -30,51 +30,68 @@ Built using JS framework NextJS (pages router), NextAuth.js, Typescript, MungoDB
 - [Typescript](https://www.typescriptlang.org/)
 - [Nextauth](https://next-auth.js.org/)
 
-## Quick Start
+## Prerequisites
 
-Install next, react and react-dom :
+This is an example of how to list things you need to use the software and how to install them.
 
-`npm install next react react-dom`
+- npm
+  ```sh
+  npm install npm@latest -g
+  ```
 
-### or
+### Installation
 
-`yarn add next react react-dom`
+Clone the repo
 
-### or
+```sh
+git clone git@github.com:raythompsonwebdev/shoestore.git
+```
 
-`pnpm add next react react-dom`
+Install NPM packages :
 
-Open package.json and add the following scripts:
+```sh
+npm install
+```
+
+### or
 
+```sh
+yarn install
 ```
-"scripts": {
-  "dev": "next dev",
-  "build": "next build",
-  "start": "next start",
-  "lint": "next lint"
-}
 
+### or
+
+```sh
+pnpm install
 ```
 
-`npm run dev`
+Open package.json and add the following scripts:
 
 Runs next dev to start Next.js in development mode.
 
+`npm run dev`
+
 Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
 
 The page will reload when you make changes. You may also see any lint errors in the console.
 
 Runs next build to build the application for production usage
 
-`npm run build`
+```sh
+npm run build
+```
 
 Runs next start to start a Next.js production server
 
-`npm run start`
+```sh
+npm run start
+```
 
 Runs next lint to set up Next.js' built-in ESLint configuration
 
-`npm run lint`
+```sh
+npm run lint
+```
 
 ## Learn More