summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarcel Müller <neikos@neikos.email>2022-07-06 11:02:35 +0200
committerMarcel Müller <neikos@neikos.email>2022-07-06 11:02:35 +0200
commit5da1da3e1a2b5abc73afeea81f1406cbcc19f446 (patch)
treed4652c7a3e2fccfedb895ab4f21d9aa06451791c
parenta96228cc8e708b52409cd938a8ea8d6632be7961 (diff)
Add README
Signed-off-by: Marcel Müller <neikos@neikos.email>
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f9446c7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# CloudMQTT
+
+[![Crates.io](https://img.shields.io/crates/v/cloudmqtt.svg)](https://crates.io/crates/cloudmqtt)
+[![Docs.rs](https://docs.rs/cloudmqtt/badge.svg)](https://docs.rs/cloudmqtt)
+[![CI](https://github.com/TheNeikos/cloudmqtt/workflows/CI/badge.svg)](https://github.com/TheNeikos/cloudmqtt/actions)
+
+A simple and straightforward to use MQTT client (and in the future server).
+
+## License
+
+Licensed under the [MPL 2.0 License](./LICENSE).
+
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the MPL 2.0 license, shall be
+licensed as above, without any additional terms or conditions.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).