From d8ce46512658a90a3340f5f6ed892287b36185cf Mon Sep 17 00:00:00 2001 From: th33xitus Date: Sat, 26 Feb 2022 17:44:59 +0100 Subject: [PATCH] readme: add shields to readme --- README.md | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 747f60f..ee13b82 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,9 @@ -# **Klipper Installation And Update Helper** - ![main_menu](resources/screenshots/kiauh.png) - ---- +# Klipper Installation And Update Helper +![GitHub](https://img.shields.io/github/license/th33xitus/kiauh) ![GitHub Repo stars](https://img.shields.io/github/stars/th33xitus/kiauh) ![GitHub forks](https://img.shields.io/github/forks/th33xitus/kiauh) ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/th33xitus/kiauh) ![GitHub last commit](https://img.shields.io/github/last-commit/th33xitus/kiauh) ![GitHub contributors](https://img.shields.io/github/contributors/th33xitus/kiauh) ### **📋 Please see the [Changelog](docs/changelog.md) for possible important information !** ---- - **📢 Disclaimer: Usage of this script happens at your own risk!** @@ -25,11 +21,9 @@ git clone https://github.com/th33xitus/kiauh.git ./kiauh/kiauh.sh ``` ---- ## **🧰 Functions and Features:** ---- ### **Core Functions:** - **Installing** Klipper to your Raspberry Pi or other Debian based Linux Distribution. @@ -49,8 +43,6 @@ git clone https://github.com/th33xitus/kiauh.git ### **For a list of additional features please see: [Feature List](docs/features.md)** ---- - ## **❗ Notes:** - Tested **only** on Raspberry Pi OS Lite (Debian 10 Buster) @@ -58,14 +50,10 @@ git clone https://github.com/th33xitus/kiauh.git - Reported to work on Armbian too - During the use of this script you might be asked for your sudo password. There are several functions involved which need sudo privileges. ---- - ## **🌐 Sources & Further Information** For more information or instructions to the various components KIAUH can install, please check out the corresponding repositories listed below: ---- - * ⛵[Klipper](https://github.com/Klipper3d/klipper) by [KevinOConnor](https://github.com/KevinOConnor) * 🌙[Moonraker](https://github.com/Arksine/moonraker) by [Arksine](https://github.com/Arksine) * 💨[Mainsail](https://github.com/mainsail-crew/mainsail) by [mainsail-crew](https://github.com/mainsail-crew) @@ -77,8 +65,6 @@ For more information or instructions to the various components KIAUH can install * 🔬[PrettyGCode](https://github.com/Kragrathea/pgcode) by [Kragrathea](https://github.com/Kragrathea) * 🤖[Moonraker-Telegram-Bot](https://github.com/nlef/moonraker-telegram-bot) by [nlef](https://github.com/nlef) ---- - ## **Credits** * A big thank you to @lixxbox for that awesome KIAUH-Logo!