Update README.md

README.md

@@ -1,6 +1,188 @@
-# LondonParkour v5
 
-## Includes
+
+<div id="top"></div>
+
+<div align="center">
+
+<div style="filter: invert(55%) sepia(83%) saturate(823%) hue-rotate(171deg) brightness(105%) contrast(94%);">
+<img src="https://cdn.jsdelivr.net/npm/@mdi/[email protected]/svg/diving-scuba-flag.svg" style="width:200px;"/>
+</div>
+
+<h3 align="center">LondonParkour.com Wordpress Theme</h3>
+
+<p align="center">
+ Hosted on DigitalOcean, this is the custom wordpress theme for LondonParkour.com
+</p> 
+</div>
+
+## 1. <a name='TableofContents'></a>Table of Contents
+
+
+* 1. [Table of Contents](#TableofContents)
+* 2. [About The Project](#AboutTheProject)
+ * 2.1. [Built With](#BuiltWith)
+ * 2.2. [Installation](#Installation)
+* 3. [Usage](#Usage)
+* 4. [ Customising](#Customising)
+* 5. [Troubleshooting](#Troubleshooting)
+* 6. [Contributing](#Contributing)
+* 7. [License](#License)
+* 8. [Contact](#Contact)
+* 9. [Changelog](#Changelog)
+ * 9.1. [v2.0.0](#v2.0.0)
+
+
+## 2. <a name='AboutTheProject'></a>About The Project
+
+Built for LondonParkour.com, this theme is a custom development. The current incarnation of the website, it uses TailwindCSS mostly for its styling.
+It tries to be as lightweight as possible by removing any usused JS or CSS too. 
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+### 2.1. <a name='BuiltWith'></a>Built With
+
+This project was built with the following frameworks, technologies and software.
+
+* [ACF](https://www.advancedcustomfields.com/)
+* [Tailwind](https://www.tailwindcss.com/)
+* [PHP](https://php.net/)
+* [Wordpress](https://wordpress.org/)
+* [Composer](https://getcomposer.org/)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+### 2.2. <a name='Installation'></a>Installation
+
+These are the steps to get up and running with this theme.
+
+1. Clone the repo into your wordpress plugin folder
+ ```sh
+ git clone https://github.com/IORoot/wp-theme__londonparkour--v5 ./wp-content/themes/parkourlabs
+ ```
+1. Enable the theme in wordpress.
+
+Note that this theme was built with many other plugins for LondonParkour.com, including ones for custom post types, pagebuilding, REST API interfaces and custom shortcodes.
+
+The full list of plugins running on LondonParkour are as follows:
+
+- advanced-custom-fields-pro
+- advanced-forms-pro
+- anime-fx__library
+- easy-wp-smtp
+- physical-custom-upload-folder
+- real-media-library
+- seo-by-rank-math
+- stripe-payments
+- wordfence
+- wp-crontrol
+- wp-plugin__acf--codemirror
+- wp-plugin__admin-themes
+- wp-plugin__advanced-forms--replyto
+- wp-plugin__andyp-plugins
+- wp-plugin__cpt--amp
+- wp-plugin__cpt--blog
+- wp-plugin__cpt--events
+- wp-plugin__cpt--support
+- wp-plugin__footer
+- wp-plugin__gcal-sync
+- wp-plugin__oauth--gCAL
+- wp-plugin__page-builder
+- wp-plugin__page-builder--epic-slider
+- wp-plugin__page-builder--flickity
+- wp-plugin__page-builder--hero
+- wp-plugin__page-builder--isotope
+- wp-plugin__page-builder--rawcode
+- wp-plugin__page-builder--video-rotator
+- wp-plugin__page-builder--yt-lite
+- wp-plugin__picture-images
+- wp-plugin__rest--view
+- wp-plugin__stripe-payments
+- wp-plugin__theme--custom-structure
+- wp-plugin__thumbnail-folders
+- wp-pluging__menu--code-inject
+- wp-rocket
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+
+## 3. <a name='Usage'></a>Usage
+
+No usage required.
+
+## 4. <a name='Customising'></a> Customising
+
+Edit the theme however you wish.
+
+## 5. <a name='Troubleshooting'></a>Troubleshooting
+
+This is purely for LondonParkour.com. No troubleshooting.
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+## 6. <a name='Contributing'></a>Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue.
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+
+## 7. <a name='License'></a>License
+
+Distributed under the MIT License.
+
+MIT License
+
+Copyright (c) 2022 Andy Pearson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+
+
+## 8. <a name='Contact'></a>Contact
+
+Author Link: [https://github.com/IORoot](https://github.com/IORoot)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+## 9. <a name='Changelog'></a>Changelog
+
+### New version 5.0.0
 
 - TailwindCSS
-- Anime.js
+- Anime.js
+
+### Veresion 4.0.0
+
+This can be found at [https://github.com/IORoot/wp-theme__londonparkour--v4](https://github.com/IORoot/wp-theme__londonparkour--v4)