Merge pull request #81 from bob8677/master

[instantos/instantOS.git] / README.md

diff --git a/README.md b/README.md
index 85e73cd..5f12758 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,31 +1,23 @@
-# suckless
-my suckless "distro"
+<div align="center">
+    <h1>instantOS</h1>
+    <p>it works. fast. powerful.</p>
+    <img width="300" height="300" src="https://raw.githubusercontent.com/instantOS/instantLOGO/master/png/logo.png">
+</div>
 
-## Installation
+<p align="left">
+<a href="https://www.buymeacoffee.com/paperbenni" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-blue.png" alt="Buy Me A Coffee" style="height: 51px !important;width: 217px !important;" ></a>
+</p>
 
-```sh
-curl https://raw.githubusercontent.com/paperbenni/suckless/master/install.sh | bash
-```
-### Installation including config files like .bashrc
+[![BECOME A PATRON](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/bePatron?u=8814964)
 
-#### WARNING THIS WILL OVERWRITE ANY EXISTING CONFIGURATION
-```sh
-curl https://raw.githubusercontent.com/paperbenni/suckless/master/dotinstall.sh | bash
-```
-## This suckless collection is made up of
-- Start menu: https://github.com/paperbenni/dmenu
-- Window-Manager: https://github.com/paperbenni/dwm
-- Terminal emulator: https://github.com/paperbenni/st
-- Lock screen: https://github.com/paperbenni/slock
+# [instantOS](https://instantos.github.io)
 
-All of these are forks of their original [suckless](https://suckless.org) projects. 
-Suckless programs are really basic , small and optimized programs that you are supposed to extend to suit your needs
-(or use someone elses configuration if you don't want to learn c or/and apply a bunch of patches)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a5ff3ab070e34744a0fd3f47c1a46a63)](https://app.codacy.com/gh/instantOS/instantOS?utm_source=github.com&utm_medium=referral&utm_content=instantOS/instantOS&utm_campaign=Badge_Grade_Settings)
+![Discord](https://img.shields.io/discord/683782260071071764)
+![Maintenance](https://img.shields.io/maintenance/yes/2020)
 
-## Requirements:
-This requires an x server, it does NOT work with wayland as it relies on x utilities
+instantOS is an Arch based distro that works out of the box but is still aimed at power users. 
 
-## OS
-It works on Arch and Ubuntu. 
-Arch being my daily driver is more tested than Ubuntu, if you have any issues, just contact me,
-the userbase being that small allows me to answer every single request. 
+## [website](https://instantos.github.io)
+
+This repo contains utilities used all around instantOS, but for a proper README refer to the [website](https://instantos.github.io)