From e06315f7d3f15dd83c5b914248d716ce8a3e3938 Mon Sep 17 00:00:00 2001 From: "bernhard.trinnes" Date: Tue, 8 Sep 2020 08:59:11 +0200 Subject: [PATCH] added readme --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8a0bf2 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# nymea plug-ins modbus + +-------------------------------------------- +

+ + + +

+ + +This repository contains modbus integrations for nymea. + +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. + + +## 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) + +## Documentation + +* A detailed description how to install and getting started with the *nymea* can be found here: + + [nymea | user documentation](https://nymea.io/documentation/users/installation/getting-started). + +* A detailed documentation for developers can be found here: + + [nymea | developer documentation](https://nymea.io/documentation/developers/). + + +## Contributing + +To contribute support for a device or service, you're welcome to file a pull request to this repository. If you need help in creating an integration plugin, feel free to ask in our forum or the Telegram group as well. + +If you don't have any developer skills at all, still feel free to bring the topic up. Our community is happy to help wherever possible." + +## 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 3 of the License.