Updated README

README.md

@@ -1,3 +1,36 @@
 # Wombat Docs
 
-The documentation for 4788s 
+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 pnpm (or equivalent) installed. Then run the following commands:
+
+
+```bash
+pnpm install
+pnpm run dev
+```
+
+## Building
+
+To build the documentation, you will need pnpm (or equivalent) installed. Then run the following commands:
+
+```bash
+pnpm install
+pnpm 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)