diff --git a/README.md b/README.md index a4e88a0..3e527d9 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,23 @@ # YSFReflector-debian-installer -This is a simple script that runs through the steps of the install at: https://register.ysfreflector.de/installation. The script currently does not have a startup/stop script and is only tested on Debian. -****** +This is a simple script to install YSFReflector. This script essentially runs through the official steps found at: https://register.ysfreflector.de/installation for you for your convenience. All you need to provide before hand is have a Debian 9.x server ready and updated. -To start YSFReflector, run: '/YSFRflector/YSFRflector YSFRflector.ini' -To stop YSFReflector: 'ps aux | grep YSFreflector', then kill the pid. -****** -Its an ugly way of starting and stopping, but it works. I will focus on fixing this in later versions of the script. For now though, it just works. +### To install on Debian 9.x: +```sh +git clone https://github.com/n5amd/YSFReflector-debian-installer +cd YSFReflector-debian-installer +./YSFReflector-debian-installer +``` -By all means, please dissect the script and make it work for your install....then share with the world. +### To interact with ysfreflector after installation: +```sh +systemctl start|stop|status|restart ysfreflector +``` + - Installs to /ysfreflector + - Logs are in /var/log/YSFReflector + +**For more information, please visit:** + +https://sadigitalradio.com/ -73!