Update documentation.

chirpstack · Jun 10, 2016 · 88fe42b · 88fe42b
1 parent 353860f
commit 88fe42b
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,16 @@ into JSON over MQTT. This project is part of [LoRa Server](https://github.com/br
 See the [http://lora-semtech-bridge.readthedocs.io/](http://lora-semtech-bridge.readthedocs.io/)
 for documentation about setting up LoRa Semtech Bridge.
 
+## Compatibility
+
+The table below shows the compatibility between LoRa Semtech Bridge and the
+available Semtech UDP protocol versions:
+
+| LoRa Semtech Bridge | Semtech UDP protocol version | Note                                                                |
+|---------------------|------------------------------|---------------------------------------------------------------------|
+| 1.x.x               | 1                            |                                                                     |
+| 2.x.x               | 2                            | This protocol is used since version 3.0.0 of the `packet_forwarder` |
+
 ## Downloads
 
 Pre-compiled binaries are available for:

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -13,6 +13,16 @@ repositories for various Linux distributions).
 
 ## Install LoRa Semtech Brige
 
+#### Compatibility
+
+The table below shows the compatibility between LoRa Semtech Bridge and the
+available Semtech UDP protocol versions:
+
+| LoRa Semtech Bridge | Semtech UDP protocol version | Note                                                                |
+|---------------------|------------------------------|---------------------------------------------------------------------|
+| 1.x.x               | 1                            |                                                                     |
+| 2.x.x               | 2                            | This protocol is used since version 3.0.0 of the `packet_forwarder` |
+
 #### Download
 
 Download and unpack a pre-compiled binary from the

diff --git a/docs/index.md b/docs/index.md
@@ -25,6 +25,16 @@ Bridge instance.
 **Important:** one gateway connection should always be load-balanced the
 same LoRa Semtech Bridge instance!
 
+## Compatibility
+
+The table below shows the compatibility between LoRa Semtech Bridge and the
+available Semtech UDP protocol versions:
+
+| LoRa Semtech Bridge | Semtech UDP protocol version | Note                                                                |
+|---------------------|------------------------------|---------------------------------------------------------------------|
+| 1.x.x               | 1                            |                                                                     |
+| 2.x.x               | 2                            | This protocol is used since version 3.0.0 of the `packet_forwarder` |
+
 ## Downloads
 
 Pre-compiled binaries are available for: