ETM-Schurig/powersync-core
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added some content to readme

Browse Source
This commit is contained in:
Boernsman 2019-05-13 15:49:28 +02:00
parent 1329fab9a6
commit 6e8fb392c5
1 changed files with 58 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -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.