Browse Source

Update README.md

Ayush Sharma 5 years ago
parent
commit
4d0ab4cbcc
1 changed files with 80 additions and 1 deletions
  1. 80 1
      README.md

+ 80 - 1
README.md

@@ -1 +1,80 @@
-# WebSerial
+<p align="center"><img src="https://raw.githubusercontent.com/ayushsharma82/WebSerial/master/docs/logo.svg?sanitize=true" width="250"></p>
+
+<hr/>
+
+<p align="center">
+<!-- <img src="https://img.shields.io/travis/com/ayushsharma82/WebSerial.svg?style=for-the-badge" />
+&nbsp; -->
+<img src="https://img.shields.io/github/last-commit/ayushsharma82/WebSerial.svg?style=for-the-badge" />
+&nbsp;
+<img src="https://img.shields.io/github/license/ayushsharma82/WebSerial.svg?style=for-the-badge" />
+&nbsp;
+<a href="https://www.patreon.com/bePatron?u=16780597" target="_blank"><img src="https://img.shields.io/badge/patreon-donate-orange.svg?style=for-the-badge&logo=patreon" /></a>
+</p>
+
+<hr/>
+
+<br/>
+
+<p><b>WebSerial</b> is a Serial Monitor for <b>ESP8266</b> & <b>ESP32</b> Microcontrollers that can be accessed remotely via a web browser. Webpage is stored in program memory of the microcontroller.</p>
+
+<br/>
+
+<h2>Preview</h2>
+<p align="center"><img src="https://raw.githubusercontent.com/ayushsharma82/WebSerial/master/docs/webserial.png" width="450"></p>
+
+<br/>
+<br/>
+<br/>
+
+<h2>Features</h2>
+<p>
+  <ul style="list-style-position: inside;">
+      <li>Works on Websockets</li>
+      <li>Realtime logging</li>
+      <li>Any number of Serial Monitors can be opened on the browser</li>
+      <li>Uses Async Webserver for better performance</li>
+  </ul>
+</p>
+
+<br/>
+<br/>
+
+<h2>Dependencies</h2>
+<p>
+  <h5>For ESP8266:</h5>
+  <ul style="list-style-position: inside;">
+      <li>ESP8266 Arduino Core - <b>v2.5.0</b></li>
+      <li>ESPAsyncTCP - <b>v1.2.0</b></li>
+  	  <li>ESPAsyncWebServer - <b>v1.2.0</b></li>
+  </ul>
+  
+  <h5>For ESP32:</h5>
+  <ul style="list-style-position: inside;">
+      <li>ESP32 Arduino Core - <b>v1.0.1</b></li>
+      <li>AsyncTCP - <b>v1.0.3</b></li>
+  	  <li>ESPAsyncWebServer - <b>v1.2.0</b></li>
+  </ul>
+</p>
+
+<br/>
+<br/>
+<br/>
+
+<h2>Contributions</h2>
+<p>Every Contribution to this repository is highly appriciated! Don't fear to create pull requests which enhance or fix the library as ultimatly you are going to help everybody.</p>
+<p>
+If you want to donate to the author then <b>you can become my patron</b>, It really helps me keep these libraries updated:
+<br/><br/>
+<a href="https://www.patreon.com/bePatron?u=16780597" target="_blank"><img src="https://img.shields.io/badge/patreon-donate-orange.svg?style=for-the-badge&logo=patreon" /></a>
+</p>
+<br/>
+<br/>
+
+
+<h2>License</h2>
+ESP-DASH is licensed under General Public License v3 ( GPLv3 ).
+<br/>
+<br/>
+<img src="https://img.shields.io/github/license/ayushsharma82/ESP-DASH.svg?style=for-the-badge" />
+</div>