diff --git a/README.md b/README.md index 101aaa1..2d4b2ca 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,23 @@ --> +

- + + + +

Make your own Smart Home automation system

+

+ Watch demo » +
+ Explore wikis + + Report bugs +
+

+ [![PHP](https://img.shields.io/badge/PHP-brightgreen.svg)](https://github.com/GamerClassN7/Smart_Home/search?l=php) [![JS](https://img.shields.io/badge/JS-red.svg)](https://github.com/GamerClassN7/Smart_Home/search?l=js) [![HTML](https://img.shields.io/badge/HTML-blue.svg)](https://github.com/GamerClassN7/Smart_Home/search?l=html) @@ -35,15 +48,13 @@ * [About Smart_Home](#about-smart_home) * [Screenshots](#screenshots) * [Installation](#instalation) +* [API](#api) * [Contributing](#contributing) * [License](#license) * [Built With](#built-with) * [Authors](#authors) -## Installation -ok that's it for today. Will make more tommorow - - + ## Screenshots ### Browser (Desktop PWA) @@ -54,15 +65,20 @@ ok that's it for today. Will make more tommorow + +## Installation +See [Wikis](https://github.com/GamerClassN7/Smart_Home/wiki) for help about installation, usage and troubleshooting. + + ## API -### POST Message (switch) +#### POST Message (switch) ``` { "token":"2" } ``` -### Answer (switch) +#### Answer (switch) ``` { "device":{ @@ -75,7 +91,7 @@ ok that's it for today. Will make more tommorow } ``` -### POST Message (sensor) +#### POST Message (sensor) ``` { "token":"4", @@ -87,16 +103,13 @@ ok that's it for today. Will make more tommorow } ``` -### Answer (sensor) +#### Answer (sensor) ``` { } ``` -## Contributions -//tu jebnę coś o pull requestach - ## Contributing @@ -108,13 +121,20 @@ If you know how to fix, improve or optimze something, go ahead and contribute! H 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Make sure everything works as intended -6. Open a Pull Request :wink: +6. Open a Pull Request ## License Distributed under the MIT License. See `LICENSE` for more information. +## Built with +This section briefly lists major frameworks that you duino-coin uses: +* [PHP](https://www.php.net) +* [JS](https://www.javascript.com) +* HTML +* [Arduino IDE](https://www.arduino.cc) + ## Authors * [GamerClassN7](https://github.com/GamerClassN7) - Lead developer