From 090ed802ee9ff0dc7e1fb1cde4120fa07eed5d05 Mon Sep 17 00:00:00 2001
From: GrafDimenzio <66207264+GrafDimenzio@users.noreply.github.com>
Date: Sat, 31 Oct 2020 13:29:55 +0100
Subject: [PATCH 1/2] Create README.md

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..da09d12
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Tranquilizer
+The Tranquilizer is a Weapon which looks like a Usp and spawns additionaly to the normal USP in a Position you can set in the Config and can stun almost every class.
+
+The Tranquilizer Itemid is 42 (so you can get it with `giveitem playerid 42`)
+
+# Credits
+Original [Scp-TranquilizerGun](https://github.com/NeonWizard/SCP-TranquilizerGun) plugin by [NeonWizard](https://github.com/NeonWizard)
+
+# Config
+| ConfigName | Type | Description |
+| :-------------: | :---------: | :------ |
+| maxStunTime | Integer | The longest time a Player can be stuned |
+| minStunTime | Integer | The shortest time a Player can be stuned |
+| dropInventory | Boolean | If the Player should drop his Inventory when he get stuned |
+| spawnRagdoll | Boolean | If a Ragdoll should spawn when a Player get stuned |
+| reloadable | Boolean | If the Tranquilizer can be reloaded |
+| blockedIDs | Integer list | The RoleIDs which can't be stuned |
+| tranquilizerSpawns | MapPoint List | The Position's where the Tranquilizer spawns |
+
+Default:
+```
+[Tranquilizer]
+{
+maxStunTime: 15
+minStunTime: 10
+dropInventory: false
+spawnRagdoll: true
+reloadable: true
+blockedIDs:
+- 0
+- 3
+tranquilizerSpawns:
+- room: HCZ_457
+  x: -1.80886805
+  y: 1.33001697
+  z: -1.07815599
+}
+```

From 51091b9fd25b1cb0026883b9a1a9e4e5cc9505d6 Mon Sep 17 00:00:00 2001
From: GrafDimenzio <66207264+GrafDimenzio@users.noreply.github.com>
Date: Sat, 31 Oct 2020 13:34:48 +0100
Subject: [PATCH 2/2] Update README.md

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index da09d12..555dafb 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,15 @@
 # Tranquilizer
-The Tranquilizer is a Weapon which looks like a Usp and spawns additionaly to the normal USP in a Position you can set in the Config and can stun almost every class.
+It' a Custom Weapon Plugin for SCP:SL(Synapse 2) that adds a tranquilizer gun (it doesn't replace a already existing weapon!).When a player is shot by it, they are temporarily ragdolled for the duration of the tranquilization
 
 The Tranquilizer Itemid is 42 (so you can get it with `giveitem playerid 42`)
 
 # Credits
 Original [Scp-TranquilizerGun](https://github.com/NeonWizard/SCP-TranquilizerGun) plugin by [NeonWizard](https://github.com/NeonWizard)
 
+# Installation
+1. Install Synapse 2
+2. Place the latest Tranquilizer.dll in `~/Synapse/plugins/server-{serverport}`
+
 # Config
 | ConfigName | Type | Description |
 | :-------------: | :---------: | :------ |