From f60e444c68d93657c0be093bbf50464e6918dcb8 Mon Sep 17 00:00:00 2001 From: Raine Date: Tue, 19 Dec 2023 00:50:52 +0100 Subject: [PATCH] doc: further documentation of the libs --- domo_lib/README.md | 10 ++++++++++ domo_proto/README.md | 4 ++++ 2 files changed, 14 insertions(+) create mode 100644 domo_lib/README.md create mode 100644 domo_proto/README.md diff --git a/domo_lib/README.md b/domo_lib/README.md new file mode 100644 index 0000000..fea05c8 --- /dev/null +++ b/domo_lib/README.md @@ -0,0 +1,10 @@ +# `domo_lib` + +This library is only here to provide developers a *streamlined* way to develop domo applications. +This way, diving into other libraries allows you to use the *same* `struct`s as anywhere else. + +While it's not required to use this library, it's highly recommended. + +## Contribute? +Think something should be different? Please tell me or make a PR! +Domo would be nothing without you! \ No newline at end of file diff --git a/domo_proto/README.md b/domo_proto/README.md new file mode 100644 index 0000000..0df9801 --- /dev/null +++ b/domo_proto/README.md @@ -0,0 +1,4 @@ +# `domo_proto` + +Low level implementation of the Domo protocol. +This library is *usually* up to date and the `MAJOR` version number is up to date with the domo protocol. \ No newline at end of file