diff --git a/README.md b/README.md index b492ab18..c17f0960 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # fxserver-esx_status FXServer ESX Status +[INSTALLATION] + +1) CD in your resources/[esx] folder +2) Clone the repository +``` +git clone https://github.com/FXServer-ESX/fxserver-esx_status esx_status +``` +3) Add this in your server.cfg : + +``` +start esx_status +``` + +[HOWTO] + +server.lua +```lua + +local name = 'hunger' +local default = 1000000 +local color = '#CFAD0F' + +TriggerEvent('esx_status:registerStatus', name, default, color, + function(status) -- Visible calllback, if it return true the status will be visible + return true + end, + function(status) -- Tick callback, what to do at each tick + status.remove(200) + end, + {remove = 200} -- Client action (add / remove) so the client can be in sync with server +) + + +```