README Rework

Documentation/Contribute.md

@@ -0,0 +1,32 @@
+
+# How To Contribute
+
+You might want to check out our [![Badge Discord]][Discord]
+
+<br>
+
+## Topics
+
+It is recommended to first search for **[Issues]** as well as <br>
+**[Pull Requests]** that match your topic before you start.
+
+<br>
+
+## Steps
+
+1. Fork the repository.
+
+2. Branch out from `dev`.
+
+3. Push your commits.
+
+4. Open a pull request.
+
+
+<!----------------------------------------------------------------------------->
+
+[Pull Requests]: https://github.com/sqfmi/Watchy/pulls
+[Issues]: https://github.com/sqfmi/Watchy/issues
+
+[Badge Discord]: https://img.shields.io/badge/Discord-7289DA?style=flat&logo=discord&logoColor=white
+[Discord]: https://discord.gg/ZXDegGV8E7

Documentation/Setup.md

@@ -0,0 +1,91 @@
+
+<h1 align = 'center'>Setup</h1>
+
+<br>
+<br>
+
+## Board
+
+In the **Arduino IDE Boards Manager** you will <br>
+need to **[Install Support][ESP32]** for the **ESP32** board.
+
+<br>
+
+##### Navigate To
+
+<kbd>**Arduino**</kbd> **›** <kbd>**Preferences**</kbd> **›** <kbd>**Additional Board Manager URLs**</kbd>
+
+<br>
+
+##### Insert
+
+```
+https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
+```
+
+<br>
+<br>
+
+---
+
+<br>
+<br>
+
+## Library
+
+In the **Library Manager**, search for `Watchy` <br>
+and install it and any of its dependencies.
+
+<br>
+<br>
+
+---
+
+<br>
+<br>
+
+## Example
+
+Check out the examples under
+
+<kbd>**Examples**</kbd> **›** <kbd>**Watchy**</kbd>
+
+<br>
+<br>
+
+---
+
+<br>
+<br>
+
+## Compile / Upload
+
+Use the following settings when building <br>
+and leave any other ones at their default.
+
+<br>
+
+Setting |        |
+:------:|:------:|
+Board            | `ESP Dev Module`
+Partition Scheme | `Minimal SPIFFS`
+
+<br>
+<br>
+
+---
+
+<br>
+<br>
+
+## Port
+
+In case your port isn't automatically detected, you may <br>
+also need to install the **[CP2104 USB To Serial Drivers][Drivers]**.
+
+<br>
+
+<!----------------------------------------------------------------------------->
+
+[Drivers]: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers
+[ESP32]: https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html

README.md

@@ -1,26 +1,42 @@
-# Watchy - Fully Open Source E-Paper Watch
+# Watchy [![Badge License]][License] [![Badge Discord]][Discord] [![Badge CrowdSupply]][CrowdSupply] [![Badge Mouser]][Mouser]
 
-![Watchy](https://watchy.sqfmi.com/img/watchy_render.png)
+***A Fully Open Source E-Paper Watch***
 
-**Buy Watchy at [Crowd Supply](https://www.crowdsupply.com/sqfmi/watchy) and [Mouser](https://www.mouser.com/ProductDetail/SQFMI/SQFMI-WATCHY-10?qs=DRkmTr78QARN9VSJRzqRxw%3D%3D)!**
+<br>
 
-[**Watchy Case & Accessories**](https://shop.sqfmi.com)
+---
 
-Visit [**https://watchy.sqfmi.com**](https://watchy.sqfmi.com) for documentation, hardware design files, and more!
+<div align = 'center'>
 
-## Setup
-1. In the Arduino IDE Boards Manager, [install support for the ESP32](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html).
-    * Arduino > Preferences > Additional Board Manager URLs
-    * ```https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json```
-2. Install this library (search for **Watchy** in the library manager), and any other dependencies when prompted
-3. Check out the examples under ```Examples``` -> ```Watchy```
-4. Compile & Upload with these board settings:
-    * Board: "ESP32 Dev Module"
-    * Partition Scheme: "Minimal SPIFFS"
-    * All Other Settings: leave to default
+  **⸢ [Website] ⸥**
+  **⸢ [Shop] ⸥**
+  **⸢ [Setup] ⸥**
+  **⸢ [Contribute] ⸥**
+
+ </div>
 
-You may also have to install the [CP2104 USB to Serial drivers](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers) if the port is not automatically detected.
+---
 
-### Have Fun! :)
+<br>
 
+![Preview]
+
+<!----------------------------------------------------------------------------->
+
+[Badge License]: https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge
+[Badge Discord]: https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white
+[Badge CrowdSupply]: https://img.shields.io/badge/CrowdSupply-00b2ad?style=for-the-badge&logo=shopify&logoColor=white 'Buy Watchy at Crowd Supply'
+[Badge Mouser]: https://img.shields.io/badge/Mouser-0070bb?style=for-the-badge&logo=shopify&logoColor=white 'Buy Watchy at Mouser'
+
+[CrowdSupply]: https://www.crowdsupply.com/sqfmi/watchy
+[Discord]: https://discord.gg/ZXDegGV8E7
+[Website]: https://watchy.sqfmi.com
+[Mouser]: https://www.mouser.com/ProductDetail/SQFMI/SQFMI-WATCHY-10?qs=DRkmTr78QARN9VSJRzqRxw%3D%3D
+[Shop]: https://shop.sqfmi.com
+
+[Preview]: https://watchy.sqfmi.com/img/watchy_render.png
+
+[Contribute]: Documentation/Contribute.md
+[Setup]: Documentation/Setup.md
+[License]: LICENSE