Merge pull request #338 from klutvott123/update-readme

README.md

@@ -1,12 +1,8 @@
-# betaflight-tx-lua-scripts
-
-## How to download the scripts
-
-Please visit the [releases page](https://github.com/betaflight/betaflight-tx-lua-scripts/releases) to download a zip file containing latest version.
+# Betaflight TX Lua Scripts
 
 ## Firmware Considerations
 
-- Betaflight - 4.1.0 or newer. As a best practice, it is recommended to use the most recent stable release of Betaflight to obtain the best possible results;
+- Betaflight - As a best practice, it is recommended to use the most recent stable release of Betaflight to obtain the best possible results;
 - OpenTX - 2.3.4 or newer;
 - Crossfire TX / RX - v2.11 or newer;
 - FrSky TX / RX - While most receivers work fine, it's recommended to update the XSR family of receivers to their most recent firmware version to correct any known bugs in SmartPort telemetry.
@@ -15,9 +11,9 @@ Please visit the [releases page](https://github.com/betaflight/betaflight-tx-lua
 
 **!! IMPORTANT: DON'T COPY THE CONTENTS OF THIS REPOSITORY ONTO YOUR SDCARD !!**
 
-Unzip the files from the link above and drag the contents to your radio. If you do this correctly, the SCRIPTS directory will merge with your existing directories, placing the scripts in their appropriate paths.  You will know if you did this correctly if the `bf.lua` file shows up in your `/SCRIPTS/TOOLS` directory.
+Download a zip file containing the latest version from the [releases page](https://github.com/betaflight/betaflight-tx-lua-scripts/releases).
 
-The src directory is not required for use and is only available for maintenance of the code.  While it may work to use this directory, you may encounter memory issues on your transmitter.
+Unzip the files from the link above and drag the contents of the `obj` folder to your radios SD card. If you do this correctly, the `SCRIPTS` directory will merge with your existing directories, placing the scripts in their appropriate paths.  You will know if you did this correctly if the `bf.lua` file shows up in your `/SCRIPTS/TOOLS` directory.
 
 ### How to install
 
@@ -46,8 +42,14 @@ Due to issues with input mapping and memory overruns, running the script as a te
 
 If you are using a VTX that supports the SmartAudio or Tramp protocols then bands and channels etc. are managed using VTX tables since Betaflight version 4.1.0. The script will be downloading and storing the current VTX table for every model the first time the model is connected and the script is run. If you change the VTX table, you have to re-load the updated VTX table in the script, by choosing the 'vtx tables' option in the function menu.
 
+### Background script
+The optional background script offers RTC synchronization and RSSI through MSP. It can be setup as a special or global function in OpenTX. The image below shows how to run the background script as a special function.
+
+![Background script setup](docs/assets/images/background_script_setup.png)
+
+
 ## Building from source
 
 - Be sure to have `make` and `luac` in version 5.2 installed in the path
 - Run `make` from the root folder
-- The installation files will be created a the `obj` in the root folder. Copy the files to your transmitter as instructed in the '[Installing](#installing)' section below as if you unzipped from a downloaded file.
+- The installation files will be created in the `obj` folder. Copy the files to your transmitter as instructed in the '[Installing](#installing)' section as if you unzipped from a downloaded file.