Merge branch 'main' of github.com:brow1633/tether

.github/workflows/CI.yml

@@ -5,18 +5,20 @@ name: CI
 
 on: # this determines when this workflow is run
   push:
-    branches: [ main ] #  when master or melodic-devel branch is pushed to
+    branches: [ main ]
   pull_request:
-    branches: [ main ] # when there is a pull request against master
+    branches: [ main ]
+  release:
+    types: [ created ]
 
 
 jobs:
   industrial_ci:
     name: ROS ${{ matrix.ROS_DISTRO }} (${{ matrix.ROS_REPO }})
     runs-on: ubuntu-latest
     strategy:
-      # fail-fast: false # uncomment if failing jobs should not cancel the others immediately
-      matrix: # matrix is the product of entries
+      fail-fast: false
+      matrix:
         ROS_DISTRO: [humble, iron, jazzy, rolling]
         ROS_REPO: [main, testing]
 

README.md

@@ -11,7 +11,7 @@ Simply clone the repository into your ROS2 workspace and build with `colcon buil
 ### Demo
 #### TCP
 ```
-ros2 launch network_bridge tcp.launch.py`
+ros2 launch network_bridge tcp.launch.py
 
 ros2 topic pub /tcp1/MyDefaultTopic std_msgs/msg/String "data: 'Hello World'"
 
@@ -27,7 +27,7 @@ ros2 topic pub /udp1/MyDefaultTopic std_msgs/msg/String "data: 'Hello World'"
 ros2 topic echo /udp2/MyDefaultTopic
 ```
 ### Configuration
-This package has a simple configuration file format that facilitates easy integration.  Simply setup the network interface parameters and list your desired topics to get started.  If you are using this over cellular data, it is recommended to setup a VPN to facilitate connection.
+Simply setup the network interface parameters and list your desired topics to get started.  If you are using UDP over cellular data, it is recommended to setup a VPN to facilitate connection.  Also, please note that **no encryption** occurs within this package.  Currently, if you would like encryption, you must use a VPN.
 
 See `config/Udp1.yaml` for a description of all parameters, as well as the TCP example configuration files.
 #### Minimal Example