Zaktualizuj 'README.md'
This commit is contained in:
parent
0cd6c69ece
commit
6db9fd7dc1
46
README.md
46
README.md
@ -4,10 +4,23 @@
|
|||||||
-->
|
-->
|
||||||
|
|
||||||
<!-- LOGO -->
|
<!-- LOGO -->
|
||||||
|
<br />
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="./app/templates/images/icon-192x192.png" height="100" width="100">
|
<a href="https://github.com/GamerClassN7/Smart_Home">
|
||||||
|
<img src="./app/templates/images/icon-192x192.png" height="100" width="100">
|
||||||
|
</a>
|
||||||
|
<h3 align="center">Make your own Smart Home automation system</h3>
|
||||||
|
<p align="center">
|
||||||
|
<a href="there will be a demo one day"><strong>Watch demo »</strong></a>
|
||||||
|
<br>
|
||||||
|
<a href="https://github.com/GamerClassN7/Smart_Home">Explore wikis</a>
|
||||||
|
<sub><sup>•</sub></sup>
|
||||||
|
<a href="https://github.com/GamerClassN7/Smart_Home">Report bugs</a>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
[![PHP](https://img.shields.io/badge/PHP-brightgreen.svg)](https://github.com/GamerClassN7/Smart_Home/search?l=php)
|
[![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)
|
[![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)
|
[![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)
|
* [About Smart_Home](#about-smart_home)
|
||||||
* [Screenshots](#screenshots)
|
* [Screenshots](#screenshots)
|
||||||
* [Installation](#instalation)
|
* [Installation](#instalation)
|
||||||
|
* [API](#api)
|
||||||
* [Contributing](#contributing)
|
* [Contributing](#contributing)
|
||||||
* [License](#license)
|
* [License](#license)
|
||||||
* [Built With](#built-with)
|
* [Built With](#built-with)
|
||||||
* [Authors](#authors)
|
* [Authors](#authors)
|
||||||
|
|
||||||
## Installation
|
<!-- SCREENSHOTS -->
|
||||||
ok that's it for today. Will make more tommorow
|
|
||||||
|
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
### Browser (Desktop PWA)
|
### Browser (Desktop PWA)
|
||||||
|
|
||||||
@ -54,15 +65,20 @@ ok that's it for today. Will make more tommorow
|
|||||||
|
|
||||||
<img src="./_README_IMG/6.png" height="250" width="125"> <img src="./_README_IMG/7.png" height="250" width="125"> <img src="./_README_IMG/8.png" height="250" width="125"> <img src="./_README_IMG/9.png" height="250" width="125"> <img src="./_README_IMG/10.png" height="250" width="125">
|
<img src="./_README_IMG/6.png" height="250" width="125"> <img src="./_README_IMG/7.png" height="250" width="125"> <img src="./_README_IMG/8.png" height="250" width="125"> <img src="./_README_IMG/9.png" height="250" width="125"> <img src="./_README_IMG/10.png" height="250" width="125">
|
||||||
|
|
||||||
|
<!-- INSTALLATION -->
|
||||||
|
## Installation
|
||||||
|
See [Wikis](https://github.com/GamerClassN7/Smart_Home/wiki) for help about installation, usage and troubleshooting.
|
||||||
|
|
||||||
|
<!-- API -->
|
||||||
## API
|
## API
|
||||||
### POST Message (switch)
|
#### POST Message (switch)
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
"token":"2"
|
"token":"2"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Answer (switch)
|
#### Answer (switch)
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
"device":{
|
"device":{
|
||||||
@ -75,7 +91,7 @@ ok that's it for today. Will make more tommorow
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### POST Message (sensor)
|
#### POST Message (sensor)
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
"token":"4",
|
"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 -->
|
<!-- CONTRIBUTING -->
|
||||||
## Contributing
|
## 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'`)
|
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||||
5. Make sure everything works as intended
|
5. Make sure everything works as intended
|
||||||
6. Open a Pull Request :wink:
|
6. Open a Pull Request
|
||||||
|
|
||||||
<!-- LICENSE -->
|
<!-- LICENSE -->
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Distributed under the MIT License. See `LICENSE` for more information.
|
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 -->
|
<!-- AUTHORS -->
|
||||||
## Authors
|
## Authors
|
||||||
* [GamerClassN7](https://github.com/GamerClassN7) - Lead developer
|
* [GamerClassN7](https://github.com/GamerClassN7) - Lead developer
|
||||||
|
Loading…
Reference in New Issue
Block a user