diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cf6ecd5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,12 @@ +This license grants permission for individuals and businesses to use the software and/or protocol under the following terms: + +1. Personal Use License: +This license grants permission for individuals to use the software, and/or protocol for personal purposes only. The software may be installed and utilized on personal devices owned or controlled by the licensee. +Conditions: +- The software and protocol is provided "as is," without warranties or conditions of any kind. +- The licensee agrees not to redistribute, sublicense, or modify the software and/or protocol for any purpose. +- This license is non-transferable. + +2. Business Use License: +For business or commercial use of this software and/or protocol, a separate license is required. +To acquire a license contact license@ixvd.net. \ No newline at end of file diff --git a/README.md b/README.md index 61d5425..3bdc1e9 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,24 @@ -Domo is a domotica system for me. +Domo is a protocol for automation. -# Nodes +## What is it? -Domo has 2 types of nodes: +Basically a L3 protocol that allows things to talk to each other. +The protocol is designed to be efficient but also agnostic, so there is some overhead. +For example, when using Domo over IP, the `src` and `dest` are pretty much overhead, or when using Domo over TCP the checksum is overhead. +However, I designed the protocol to keep all essentials in so that you could use this protocol without worrying about drivers that talk to the master node. -- Master node; the control node. -- Slave nodes; the other nodes. +## Who's using it? -## Master node -The difference between a master node and a slave node is that everything connects to it. \ No newline at end of file +- Me! + +## How well is it supported? + +Well, as long as I am in the "Who's using it?", Domo will get bugfixes and feature updates. +If you're using it personally and discover issues with the protocol, you can: +- Send me an email: `raine@ixvd.net` +- Create an issue in this repo + +## Can I use it? + +Yes, please do! +However, please look at [`./LICENSE`](./LICENSE) before using this stack. \ No newline at end of file diff --git a/doc/protocol.md b/doc/protocol.md index f0eb6cb..0d6adb8 100644 --- a/doc/protocol.md +++ b/doc/protocol.md @@ -1,6 +1,6 @@ > **Version:** `1` > **Authored by:** `Raine ` -> + # Table of contents - [Table of contents](#table-of-contents) - [Prelude](#prelude)