diff --git a/docs/README.md b/docs/README.md index 6c5dce85..b8f6e38c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,13 +10,20 @@ permalink: /livemap-interface [![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-) +
+ +
++ +
+ This is the Web Interface for the FiveM addon [live_map](https://github.com/TGRHavoc/live_map). - [Prerequisites](#prerequisites) - [How to install](#how-to-install) -- [Frequently Asked Questions](#frequently-asked-questions) -- [Adding custom maps](#adding-custom-maps) -- [Developers Information](#developers-information) +- [Frequently Asked Questions β](#frequently-asked-questions-) +- [Adding custom maps πΊοΈ](#adding-custom-maps-οΈ) +- [Developers Information π§βπ»](#developers-information-) - [Contributors β¨](#contributors-) ## Prerequisites @@ -24,13 +31,13 @@ This is the Web Interface for the FiveM addon [live_map](https://github.com/TGRH In order to have this working, it is advised that you already have a webserver running and correctly configured. You will also need to install [live_map](https://github.com/TGRHavoc/live_map) on your FiveM server and have it configured. -## How to install +## How to install Download the [latest version](https://github.com/TGRHavoc/live_map-interface/archive/master.zip). This should be enough to get the interface up and running on your website. If you want to change stuff like the images, look in the [configuration](config.md) section. -## Frequently Asked Questions +## Frequently Asked Questions β If you run into any issues, consult the [F.A.Q.](FAQ.md) first. Amongst other things, this document contains information about common issues involving: - server not connecting/showing up @@ -38,10 +45,10 @@ If you run into any issues, consult the [F.A.Q.](FAQ.md) first. Amongst other th - errors getting blips - issues with localhost -## Adding custom maps +## Adding custom maps πΊοΈ Information on how to add custom maps from GTA or alternative into livemap. See [Custom Maps](custom_maps.md). -## Developers Information +## Developers Information π§βπ» Useful information for developers on dependencies and files locations for development. See [Developers Information](developers.md). @@ -58,12 +65,14 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d