From f7415d297d2813f3d455a970711d308bcbb8c89d Mon Sep 17 00:00:00 2001 From: Jordan Dalton Date: Tue, 27 Jul 2021 10:09:29 +0100 Subject: [PATCH] docs(readme): add images to readme --- docs/README.md | 27 ++++++++++++++++++--------- docs/images/LiveMap logo.svg | 1 + 2 files changed, 19 insertions(+), 9 deletions(-) create mode 100644 docs/images/LiveMap logo.svg 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-) +

+ LiveMap +

+

+ LiveMap +

+ 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
Tom

πŸ› πŸ’»
AciD

πŸ› πŸ’»
jiynn

πŸ› -
127.0.0.1

πŸ› πŸ’» -
David Wheatley

πŸ’» πŸ› +
127.0.0.1

πŸ› πŸ’» +
David Wheatley

πŸ’» πŸ›
David Okpare

πŸ“–
matsn0w

πŸ’» + +
Jason Olsen

πŸ›
Aaron-Downham

πŸ›
Annihilator4423

πŸ“– diff --git a/docs/images/LiveMap logo.svg b/docs/images/LiveMap logo.svg new file mode 100644 index 00000000..801e98de --- /dev/null +++ b/docs/images/LiveMap logo.svg @@ -0,0 +1 @@ +LiveMap logoLive Map \ No newline at end of file