diff --git a/README.md b/README.md index e1dc571b13..d445abd4c1 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,27 @@ -# thingsboard -OpenSource IoT Platform - -![Dashboard](/img/dashboard.gif?raw=true "Real-time Fleet Dashboard") +# Thingsboard -**Docker usage** + -**start platfrom using docker:** +## Introduction + +Tningsboard is an open-source IoT platform for data collection, processing, visualization, and device management. + +![Dashboard](./img/dashboard.gif?raw=true "Real-time Fleet Dashboard") + + +## Community + + +## Contribute + + +## Support + + +## Docker usage + +**start platform using docker:** - install docker - cd to 'docker' folder - create folder for cassandra data directory on your local env (host) @@ -30,3 +45,7 @@ if you would like to change cassandra port, change it to "9999:9042" for example - modify .env file to point to the directory created in previous step - start ./deploy_cassandra_zookeeper.sh script to run cassandra with thingsboard schema and zookeper services - Start boot class: _org.thingsboard.server.ThingsboardServerApplication_ + +## Licenses + +This project is released under [Apache 2.0 license](./LICENSE). \ No newline at end of file diff --git a/img/logo.png b/img/logo.png new file mode 100644 index 0000000000..0f3b57bc6b Binary files /dev/null and b/img/logo.png differ