diff --git a/README.md b/README.md index bf3bf3a..a13e012 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,52 @@ -# rustdesk-server-pro -Some scripts for RustDesk Server Pro are hosted here. +# RustDesk Server PRO +Here we have a small collection of some scripts for RustDesk Server Pro. > If you are looking for the open source version please go to [RustDesk Server](https://github.com/rustdesk/rustdesk-server) + +# Contributing to this repo + +You are very welcome to add your PR to improve the current scripts. Some pointers: + +### The lib file + +The lib.sh is used to avoid duplicate code. Here we collect everything that occurs more than once in the varoius scripts. That could be both `functions()` and `$variables`. + +### Indentation + +We always use four (4) spaces, not one (1) tab. Please see below for examples. + +### IF arguments and functions + +The current style is to use it like this: + +``` +if something +then + do something +fi +``` +Not like: +``` +if something; then + do something +fi +``` + +Same applies for functions: + +``` +examplefuntion() [ + if something + then + do something + fi +} +``` + +### Variables + +Variables are always written in CAPITAL LETTERS. + +``` +EXAMPLEVARIABLE=true +```