Update build.yml

Update README.md

.github/workflows/build.yml

@@ -5,6 +5,10 @@ on:
     branches: [ "main" ]
   pull_request:
     branches: [ "main" ]
+    paths-ignore:
+      - 'README.md'
+      - '.gitignore'
+      - 'LICENSE'
 
 env:
   BUILD_NUMBER: ${{ github.run_number }}
@@ -12,7 +16,6 @@ env:
   PROJECT_NAME: "WeaponPaints"
   OUTPUT_PATH: "./WeaponPaints"
 
-
 jobs:
   build:
     permissions: write-all

README.md

@@ -1,30 +1,28 @@
-# cs2-WeaponPaints
+# CS2 Weapon Paints
 
-### Description
-Unfinished, unoptimized and not fully functional ugly demo weapon paints plugin for [CSSharp](https://docs.cssharp.dev/).
-There will be a lot of frequent changes which may break functionality or compatibility. You have been warned!
+## Description
+Unfinished, unoptimized and not fully functional ugly demo weapon paints plugin for **[CSSharp](https://docs.cssharp.dev/)**.
 
-## Created [Discord server](https://discord.gg/mwEQppJ5AT) where you can discus about plugin.
+## Created [Discord server](https://discord.gg/EEg6qtNScq) where you can discus about plugin.
 
 ### Consider to donate instead of buying from unknown sources.
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E2G0P2O) or [Donate on Steam](https://steamcommunity.com/tradeoffer/new/?partner=41515647&token=gW2W-nXE)
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/E1E2G0P2O) or [![Donate on Steam](https://github.com/Nereziel/cs2-WeaponPaints/assets/32937653/a0d53822-4ca7-4caf-83b4-e1a9b5f8c94e)](https://steamcommunity.com/tradeoffer/new/?partner=41515647&token=gW2W-nXE)
 
-### Features
-- changes only paint, seed and wear on weapons and knives
-- mysql based or global website at [weaponpaints.fun](https://weaponpaints.fun/), so you dont need mysql/website
-- data sync on player connect
-- Added command `!wp` to refresh skins (with cooldown in second can be configured)
-- Added command `!ws` to show website
-- Added command `!knife` to show menu with knives
-- Knife change is now limited to have these cvars empty `mp_t_default_melee ""` and `mp_ct_default_melee ""`
+## Features
+- Changes only paint, seed and wear on weapons and knives;
+- MySQL based or global website at [weaponpaints.fun](https://weaponpaints.fun/), so you dont need MySQL/Website;
+- Data sync on player connect;
+- Added command **`!wp`** to refresh skins; ***(with cooldown in second can be configured)***
+- Added command **`!ws`** to show website;
+- Added command **`!knife`** to show menu with knives;
+- Knife change is now limited to have these cvars empty **`mp_t_default_melee ""`** and **`mp_ct_default_melee ""`**;
 
-### CS2 server:
-- compile and copy plugin to plugins. Info here [https://docs.cssharp.dev/guides/hello-world-plugin/](https://docs.cssharp.dev/guides/hello-world-plugin/)
-- setup `addons/counterstrikesharp/configs/plugins/WeaponPaints/WeaponPaints.json`
-  set `GlobalShare` to true for global, or include database credentials
-- in `addons/counterstrikesharp/configs/core.json` set **FollowCS2ServerGuidelines** to **false**
+## CS2 Server
+- Compile and copy plugin to plugins, [more info here](https://docs.cssharp.dev/guides/hello-world-plugin/);
+- Setup **`addons/counterstrikesharp/configs/plugins/WeaponPaints/WeaponPaints.json`** set **`GlobalShare`** to **`true`** for global, or include database credentials;
+- in **`addons/counterstrikesharp/configs/core.json`** set **FollowCS2ServerGuidelines** to **`false`**;
 
-### Plugin configuration:
+## Plugin Configuration
 <details>
   <summary>Spoiler warning</summary>
 <code><pre>{
@@ -65,19 +63,18 @@ There will be a lot of frequent changes which may break functionality or compati
 }</pre></code>
 </details>
     
-### Web install:
-- not needed if config `GlobalShare = true`
-- requires PHP min v7.3 (tested on php ver `8.2.3` and nginx webserver)
-- copy website to web server (img folder not needed)
-- import `database.sql` to mysql
-- get steam api key [https://steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey)
-- fill in database credentials and api key in `class/config.php`
-- visit website and login via steam
+## Web install
+Disregard if the config is **`GlobalShare = true`**;
+- Requires PHP >= 7.4; ***(Tested on php ver **`8.2.3`** and nginx webserver)***
+- Copy website to web server; ***(Folder `img` not needed)***
+- Get [Steam API Key](https://steamcommunity.com/dev/apikey);
+- Fill in database credentials and api key in `class/config.php`;
+- Visit website and login via steam;
 
-### Known issues
+## Known issues
 - Issue on Windows servers, no knives are given.
 
 ### Use this plugin at your own risk! Using this may lead to GSLT ban or something else Valve come with. [Valve Server guidelines](https://blog.counter-strike.net/index.php/server_guidelines/)
 
-### Preview
+## Preview
 ![preview](https://github.com/Nereziel/cs2-WeaponPaints/blob/main/website/preview.png?raw=true)