Made the README.md look beautiful :)

This commit is contained in:
Mathias Wagner
2022-04-10 00:25:13 +02:00
parent 9d1bc2914b
commit 17f4b24c4d

View File

@@ -1,2 +1,72 @@
# myspeed
Eine deutschsprachige Speedtest Analyse-Software, welche das Internet der letzten 24 Stunden übersichtlich darstellt.
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
<br />
<p align="center">
<a href="https://github.com/gnmyt/myspeed">
<img src="https://i.imgur.com/aCmA6rH.png" alt="Logo" width="80" height="80">
</a>
</p>
<h3 align="center">MySpeed</h3>
## Was ist das?
MySpeed ist eine deutschsprachige Speedtest Analyse-Software, welche das Internet der letzten 24 Stunden übersichtlich
darstellt.
### Installation
1. Stelle sicher, dass du nodejs installiert hast.
2. Lade dir die neuste Version aus den [Releases](https://github.com/gnmyt/myspeed/releases/latest) herunter.
3. Setze die Umgebungsvariable `NODE_ENV` auf `production`.
4. Starte das Projekt. Das geht ganz einfach mit `node server`
### Beispiel-Screenshots
#### Startseite
<img src="https://i.imgur.com/vYWe5RJ.png">
#### Auswahl-Menü
<img src="https://i.imgur.com/vRhBYD2.png">
#### Seite während eines Speedtests
<img src="https://i.imgur.com/V7E3xH9.png">
#### Dialog für Einstellen des Down-Speeds
<img src="https://i.imgur.com/Pxw42b8.png">
## Überzeugt?
Du kannst dir das Projekt ganz easy herunterladen und auf deinen Server Zuhause installieren. Gib mir gerne Feedback,
falls ich etwas besser machen kann! :)
## Lizenz
Verbreitet unter der MIT-Lizenz. Siehe `LICENSE` für weitere Informationen.
[contributors-shield]: https://img.shields.io/github/contributors/gnmyt/myspeed.svg?style=for-the-badge
[contributors-url]: https://github.com/gnmyt/myspeed/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/gnmyt/myspeed.svg?style=for-the-badge
[forks-url]: https://github.com/gnmyt/myspeed/network/members
[stars-shield]: https://img.shields.io/github/stars/gnmyt/myspeed.svg?style=for-the-badge
[stars-url]: https://github.com/gnmyt/myspeed/stargazers
[issues-shield]: https://img.shields.io/github/issues/gnmyt/myspeed.svg?style=for-the-badge
[issues-url]: https://github.com/gnmyt/myspeed/issues
[license-shield]: https://img.shields.io/github/license/gnmyt/myspeed.svg?style=for-the-badge
[license-url]: https://github.com/gnmyt/myspeed/blob/master/LICENSE