From 12a65b8f1fe95d8cdc7586c26dad37d92dec0448 Mon Sep 17 00:00:00 2001
From: Sachin <31343375+Cruze03@users.noreply.github.com>
Date: Sat, 11 May 2024 17:09:42 +0530
Subject: [PATCH] Add configuration details

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 49af274..c38627b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
 # cs2_WorkshopDefaultMap
 A CSSharp plugin to set default map after server restart till valve fixes it.
+
+Configuration:
+1) Place the latest release in your plugins folder and (re)start the server. This is to generate config file in `addons/counterstrikesharp/configs/WorkshopDefaultMap/WorkshopDefaultMap.json`.
+2) Open the above json file in your favourite text editor and add your workshop mapname or workshop mapid in `Map`.
+3) Restart the server.
+
+> [!Caution]
+> • If you added workshop mapname in the config file, make sure the map is in some workshop collection and you must have `host_workshop_collection` in your server startup line.
+
+> [!Caution]
+> • If you added workshop mapid in the config file, it isn't compulsory to add `host_workshop_collection` in your server startup line but server might change the map to that specific map twice in this case (This will be the case only till CSSharp exposes `Server.WorkshopID` variable)