strix/domo
strix/domo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

doc(feat+fix): added license, changed readme and line fix in proto doc

Browse source
This commit is contained in:
Strix 2023-12-10 03:52:59 +01:00
parent cea167c164
commit 2973a703cc
No known key found for this signature in database
GPG key ID: 5F35B3B8537287A7
3 changed files with 33 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
LICENSE Normal file
View file

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

27
README.md
View file

@ -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. ## Who's using it?
- Slave nodes; the other nodes.
## Master node - Me!
The difference between a master node and a slave node is that everything connects to it.
## 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.

2
doc/protocol.md
View file

@ -1,6 +1,6 @@
> **Version:** `1` > **Version:** `1`
> **Authored by:** `Raine <raine@ixvd.net>` > **Authored by:** `Raine <raine@ixvd.net>`
>
# Table of contents # Table of contents
- [Table of contents](#table-of-contents) - [Table of contents](#table-of-contents)
- [Prelude](#prelude) - [Prelude](#prelude)