From 1163de6e9b0066bf971886eaa8c8e4fd5805ec10 Mon Sep 17 00:00:00 2001
From: Paul Hodges <paul.hodges@student.education.wa.edu.au>
Date: Wed, 10 Jan 2024 16:16:35 +0800
Subject: [PATCH 1/4] Updated README (1/2)

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5edb1eb..f8f7527 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,3 @@
 # Wombat Docs
 
-The documentation for 4788s 
\ No newline at end of file
+The documentation for 4788s wombat library.
\ No newline at end of file

From 30fada9a2514a2ea47251426d7f5338ec748049e Mon Sep 17 00:00:00 2001
From: Paul Hodges <paul.hodges@student.education.wa.edu.au>
Date: Wed, 10 Jan 2024 16:22:01 +0800
Subject: [PATCH 2/4] Updated docs

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f8f7527..51cc418 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,35 @@
 # Wombat Docs
 
-The documentation for 4788s wombat library.
\ No newline at end of file
+The documentation for 4788s wombat library.
+
+> [!IMPORTANT]
+> View the production version of the documentation here: [https://4788-docs.vercel.app/](https://4788-docs.vercel.app/)
+
+## Contributing
+
+If you would like to contribute to the documentation, please fork the repository and make a pull request into the master branch here: [https://github.com/CurtinFRC/Wombat-Docs.git](https://github.com/CurtinFRC/Wombat-Docs.git).
+
+## Running
+
+To run the documentation locally, you will need npm (or equivalent) installed. Then run the following commands:
+
+```bash
+npm install
+npm run dev
+```
+
+## Building
+
+To build the documentation, you will need npm (or equivalent) installed. Then run the following commands:
+
+```bash
+npm install
+npm run build
+```
+
+The built documentation will be in the `dist` directory.
+
+You can find the most updated code for wombat in our [GitHub repository](https://github.com/CurtinFRC/2024-Crescendo). Wombat will be located in the `wombat` directory of the repository.
+
+> [!NOTE]
+> You can also find a less up to date version of wombat in a separate repository [here](https://github.com/CurtinFRC/Wombat)
\ No newline at end of file

From d9ebb67efce5d73769f284d9c779e1141b0f0ad7 Mon Sep 17 00:00:00 2001
From: Paul Hodges <paul.hodges@student.education.wa.edu.au>
Date: Wed, 10 Jan 2024 16:24:04 +0800
Subject: [PATCH 3/4] Updated docs

---
 README.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.md b/README.md
index 51cc418..c4b3df8 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,9 @@ If you would like to contribute to the documentation, please fork the repository
 
 To run the documentation locally, you will need npm (or equivalent) installed. Then run the following commands:
 
+> [!TIP]
+> Use pnpm instead of npm for faster install and build times. Install it with `npm install -g pnpm`
+
 ```bash
 npm install
 npm run dev

From da86782d0507e081224342ab4d9a4e345b9347a4 Mon Sep 17 00:00:00 2001
From: Paul Hodges <paul.hodges@student.education.wa.edu.au>
Date: Wed, 10 Jan 2024 16:25:47 +0800
Subject: [PATCH 4/4] Updated docs

---
 README.md | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index c4b3df8..efdebfa 100644
--- a/README.md
+++ b/README.md
@@ -11,23 +11,21 @@ If you would like to contribute to the documentation, please fork the repository
 
 ## Running
 
-To run the documentation locally, you will need npm (or equivalent) installed. Then run the following commands:
+To run the documentation locally, you will need pnpm (or equivalent) installed. Then run the following commands:
 
-> [!TIP]
-> Use pnpm instead of npm for faster install and build times. Install it with `npm install -g pnpm`
 
 ```bash
-npm install
-npm run dev
+pnpm install
+pnpm run dev
 ```
 
 ## Building
 
-To build the documentation, you will need npm (or equivalent) installed. Then run the following commands:
+To build the documentation, you will need pnpm (or equivalent) installed. Then run the following commands:
 
 ```bash
-npm install
-npm run build
+pnpm install
+pnpm run build
 ```
 
 The built documentation will be in the `dist` directory.