From 6e8fb392c5a0f0adf131959ffdfff545fac658bd Mon Sep 17 00:00:00 2001 From: Boernsman Date: Mon, 13 May 2019 15:49:28 +0200 Subject: [PATCH 1/5] added some content to readme --- README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 58 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 73e8c232..fb6cda7a 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,73 @@ -# nymea +# nymea - open source IoT edge server -------------------------------------------- -*nymea* is an open source IoT (Internet of Things) server, which allows to control a lot of different devices from many different manufacturers. With the powerful rule engine you are able to connect any device available in the system and create individual scenes and behaviors for your environment. +![nymea logo](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/nymea-logo.svg) -## Getting started --------------------------------------------- -In order to getting started with *nymea* and find information you can take a look at following links: +nymea (/[n'aiːmea:]/ - is an open source IoT (Internet of Things) server, which allows to control a lot of different devices from many different manufacturers. With the powerful rule engine you are able to connect any device available in the system and create individual scenes and behaviours for your environment. + +## Quick Install on Ubuntu + +![nymea loves ubuntu](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/nymea-ubuntu.svg) + +In order to install nymea on Ubuntu, you simply need to download this bash script: + +``` +wget https://downloads.nymea.io/install-nymea.sh +``` +Extract into your Home folder and just run + +``` +chmod +x install-nymea.sh +sudo ./install-nymea.sh +``` +Once the success message has printed on your screen, simply run: *sudo nymead -n* to start nymea! + +## Quick Install on a Raspberry Pi + +![nymea loves Raspberry Pi](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/nymea-pi.svg) + +We have created an image for your Raspberry Pi (2/3) that comes with an array of plugins for different smart devices! + [Download .zip](https://downloads.nymea.io/images/rpi3/nymea-debian-stretch-9-armhf-raspberry-pi-3.zip) + +## Get the nymea mobile app here: + +![nymea app iOS](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/community/app-shots/ios-app.png) + +[nymea for iPhone](https://itunes.apple.com/us/app/nymea-app/id1400810250?mt=8) + +![nymea app Android](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/community/app-shots/android-app.png) + +[nymea for Android](https://play.google.com/store/apps/details?id=io.guh.nymeaapp&hl=en&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1) + +## Get the nymea desktop app here: + +![nymea app desktop](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/community/app-shots/desktop-app.png) + +[nymea for macOS](https://downloads.nymea.io/nymea-app/nymea-app-osx-bundle.dmg) + +[nymea for Linux](https://snapcraft.io/nymea-app) + +[nymea for Windows](https://downloads.nymea.io/nymea-app/nymea-app-win-installer.exe) + +## Getting help + +If you want to present your project or want to share your newest developments you can share it in +[Our Forum](https://forum.nymea.io) + +If you are facing any troubles, don't hesitate to reach out for us or the community members, we will be pleased to help you: +Chat with us on [Telegram](http://t.me/nymeacommunity) + +## Wiki and Documentation * A detailed description how to install and getting started with the *nymea* can be found in the - [nymea | github wiki](https://wiki.nymea.io). + [nymea | github wiki](https://wiki.nymea.io). * A detailed documentation of the source code can be found in the [nymea | developer documentation](https://doc.nymea.io). -## Donate --------------------------------------------- -We are grateful for any help! - -[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SNATFFJGNRUZ6) - ## License -------------------------------------------- > nymea 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, version 2 of the License. - From aabe5a77e67b7878a14c0358bc1c8d08d1baf394 Mon Sep 17 00:00:00 2001 From: Bernhard Trinnes Date: Mon, 13 May 2019 16:53:15 +0200 Subject: [PATCH 2/5] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index fb6cda7a..5cda068c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # nymea - open source IoT edge server -------------------------------------------- - -![nymea logo](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/nymea-logo.svg) + nymea (/[n'aiːmea:]/ - is an open source IoT (Internet of Things) server, which allows to control a lot of different devices from many different manufacturers. With the powerful rule engine you are able to connect any device available in the system and create individual scenes and behaviours for your environment. From 3241534ed1cd575d63a11a0258f13e2e7a2873ea Mon Sep 17 00:00:00 2001 From: Bernhard Trinnes Date: Mon, 13 May 2019 17:29:15 +0200 Subject: [PATCH 3/5] Resized images --- README.md | 43 +++++++++++++++++++++++++++---------------- 1 file changed, 27 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 5cda068c..0851281d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ # nymea - open source IoT edge server -------------------------------------------- - +

+ + + +

-nymea (/[n'aiːmea:]/ - is an open source IoT (Internet of Things) server, which allows to control a lot of different devices from many different manufacturers. With the powerful rule engine you are able to connect any device available in the system and create individual scenes and behaviours for your environment. +nymea (/[n'aiːmea:]/ - is an open source IoT edge server. It allows to control a lot of different things. With the powerful rule engine you are able to connect any device or services available in the system and create individual scenes and behaviours for your environment. ## Quick Install on Ubuntu -![nymea loves ubuntu](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/nymea-ubuntu.svg) + In order to install nymea on Ubuntu, you simply need to download this bash script: @@ -23,30 +27,37 @@ Once the success message has printed on your screen, simply run: *sudo nymead -n ## Quick Install on a Raspberry Pi -![nymea loves Raspberry Pi](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/nymea-pi.svg) + We have created an image for your Raspberry Pi (2/3) that comes with an array of plugins for different smart devices! [Download .zip](https://downloads.nymea.io/images/rpi3/nymea-debian-stretch-9-armhf-raspberry-pi-3.zip) ## Get the nymea mobile app here: -![nymea app iOS](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/community/app-shots/ios-app.png) +

+ +

-[nymea for iPhone](https://itunes.apple.com/us/app/nymea-app/id1400810250?mt=8) + + + +
nymea for iOS + nymea for Android +
-![nymea app Android](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/community/app-shots/android-app.png) - -[nymea for Android](https://play.google.com/store/apps/details?id=io.guh.nymeaapp&hl=en&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1) ## Get the nymea desktop app here: +

+ +

-![nymea app desktop](https://nymea.io/app/default/assets/addons/default/guh/default-theme/resources/img/community/app-shots/desktop-app.png) - -[nymea for macOS](https://downloads.nymea.io/nymea-app/nymea-app-osx-bundle.dmg) - -[nymea for Linux](https://snapcraft.io/nymea-app) - -[nymea for Windows](https://downloads.nymea.io/nymea-app/nymea-app-win-installer.exe) + + + + + +
nymea for macOS + nymea for Linux nymea for Windows
## Getting help From 04187bbe778735139953b89a7ef07ff73d59a9b6 Mon Sep 17 00:00:00 2001 From: Bernhard Trinnes Date: Mon, 13 May 2019 17:39:19 +0200 Subject: [PATCH 4/5] Updated description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0851281d..79090ade 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

-nymea (/[n'aiːmea:]/ - is an open source IoT edge server. It allows to control a lot of different things. With the powerful rule engine you are able to connect any device or services available in the system and create individual scenes and behaviours for your environment. +nymea (/[n'aiːmea:]/ - is an open source IoT edge server. The plug-in based architecture allows to integrate protocols, APIs and . With the build-in rule engine you are able to interconnect devices or services available in the system and create individual scenes and behaviours for your environment. ## Quick Install on Ubuntu From d63029ca2b538879d22f45e54119fbbc803f16cb Mon Sep 17 00:00:00 2001 From: Bernhard Trinnes Date: Tue, 14 May 2019 10:51:10 +0200 Subject: [PATCH 5/5] added badges to README --- README.md | 49 +++++++++++++++++++++++++++++++++++++------------ 1 file changed, 37 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 79090ade..15bf2df9 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # nymea - open source IoT edge server --------------------------------------------

- - + +

-nymea (/[n'aiːmea:]/ - is an open source IoT edge server. The plug-in based architecture allows to integrate protocols, APIs and . With the build-in rule engine you are able to interconnect devices or services available in the system and create individual scenes and behaviours for your environment. +nymea (/[n'aiːmea:]/ - is an open source IoT edge server. The plug-in based architecture allows to integrate protocols and APIs. With the build-in rule engine you are able to interconnect devices or services available in the system and create individual scenes and behaviours for your environment. ## Quick Install on Ubuntu @@ -35,27 +35,52 @@ We have created an image for your Raspberry Pi (2/3) that comes with an array of ## Get the nymea mobile app here:

- +

- +
- +
nymea for iOS - nymea for Android + +

+ + iOS Badge +

+ 		+

+ + Android Badge +

+
## Get the nymea desktop app here:

- +

- +
- - + + +
nymea for macOS - nymea for Linux nymea for Windows +

+ + macOS Badge +

+ 		+

+ + Snap Badge +

+ 		+

+ + Windows Badge +

+