From 8bb64155cb31a3e8a7fd20eb667a9e0e8c98c64c Mon Sep 17 00:00:00 2001
From: Loaf <60279520+loaf-scripts@users.noreply.github.com>
Date: Sun, 7 Nov 2021 23:48:14 +0100
Subject: [PATCH] Description

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8a9ba56..ec1e73e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
 # loaf_spikestrips
-FiveM spikestrips, only bursts the tyres that are actually touching the spikestrip. 
+FiveM Spikestrips, only bursts the tyres that are actually touching the spikestrip. 
+YouTube Showcase: https://www.youtube.com/watch?v=D3UtNxFXnpU
+
+## Features
+* Animation when laying down a spikestrip
+* You can remove spikestrips
+* Only the tyre that is touching the spikestrip will burst, unlike some other resources which bursts all tyres.
+
+## Standalone & ESX.
+The script works without ESX and with ESX. (please note that you should remove the spikestrip part from your esx_policejob if you intend on using this resource).
+If you only want certain jobs to be able to use spikestrips but you don't have ESX, set `Config.JobBased.Enabled` to true, [line 3 in the config.lua](https://github.com/loaf-scripts/loaf_spikestrips/blob/main/config.lua#L3). You can edit who is able to use the script at the server.lua, simply add an identifier (any identifier works) to the `police` table in the [server/main.lua](https://github.com/loaf-scripts/loaf_spikestrips/blob/main/server/main.lua#L1) file.
+
+If you only want certain jobs to be able to use spikestrips and you use ESX, set `Config.JobBased.Enabled` to ture [line 3 in the config.lua](https://github.com/loaf-scripts/loaf_spikestrips/blob/main/config.lua#L3) and also set `Config.JobBased.ESX` to true [line 4 in the config.lua](https://github.com/loaf-scripts/loaf_spikestrips/blob/main/config.lua#L4). You can configure what jobs are able to use spikestrips by editing the `PoliceJobs` table in the config.