aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIndrajith K L2021-05-17 16:55:46 +0530
committerIndrajith K L2021-05-17 16:55:46 +0530
commit6cacec3f04b0f766caafde05753ae3470244d20d (patch)
treec178ca9b2bdc08ba7f30124b29e357fe4d29a4d1 /README.md
parent05a44ebcfce184b1ee89f0c983623ff0e17059a9 (diff)
downloadSensorClientXMPP-6cacec3f04b0f766caafde05753ae3470244d20d.tar.gz
SensorClientXMPP-6cacec3f04b0f766caafde05753ae3470244d20d.tar.bz2
SensorClientXMPP-6cacec3f04b0f766caafde05753ae3470244d20d.zip
:pencil: Updates Readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5320260
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+## XMPP Sensor Client Application
+<hr>
+
+This is a simple Sensor Client Application which can be used to communicate with [OpenWeatherMapSensor](https://github.com/PeterWaher/OpenWeatherMapSensor) or any other IoT Sensor which supports [IEEE P1451.99](https://gitlab.com/IEEE-SA/XMPPI/IoT).
+
+#### Notes
+* For Device discovery search you can narrow down the search results with adding additional paramaters to the ```FindFriends``` method (Look for ```Search.Add```)
+
+<br>
+
+```Important : You need to have an API Key and Secret from a IoT Broker which supports IEEE P1451.99.```