diff --git a/README.md b/README.md index c8f54d1..b668ff7 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,14 @@ RightMesh into your own application. `./gradlew run` or `./build/install/HelloJavaMesh/bin/HelloJavaMesh` ## Notes on running +If you have an Internet connection, HelloJavaMesh will connect to a RightMesh +Superpeer and discover peers around the world who are also connected +to a superpeer. -If you have an Internet connection, HelloJavaMesh will connect to a RightMesh Superpeer and discover peers around the world who are also connected to a superpeer. - -At this time, the java library does not automatically join the RM network -so it is up to the developer to manually join the network with the device -the java code is running on. For testing purposes you should be able to -join any mobile phone network starting with RM-XXXXXX with the password +At this time, the Java library does not automatically join the local mesh +network so it is up to the developer to manually join the network with the +device the Java code is running on. For testing purposes you should be able to +join any WiFi network being broadcast by a phone running RightMesh with an +SSID following the pattern RM-XXXXXX using the password `m3sht3st`. BT connectivity is not supported at this time. diff --git a/src/main/java/HelloJavaMesh.java b/src/main/java/HelloJavaMesh.java index 47893d9..3f3c983 100644 --- a/src/main/java/HelloJavaMesh.java +++ b/src/main/java/HelloJavaMesh.java @@ -1,3 +1,20 @@ +/** HelloMesh: A sample RightMesh app for Java platforms. + Copyright (C) 2018 RightMesh AG + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + */ + import io.left.rightmesh.id.MeshId; import io.left.rightmesh.mesh.JavaMeshManager; import io.left.rightmesh.mesh.MeshManager;