instantshutdown case

[instantos/instantOS.git] / README.md

diff --git a/README.md b/README.md
index 332f362..1117207 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,20 @@
-# suckless
-my suckless programs
+<div align="center">
+    <h1>instantOS</h1>
+    <p>an out of the box distro that appeals to powerusers</p>
+    <img width="300" height="300" src="https://raw.githubusercontent.com/instantOS/instantLOGO/master/png/logo.png">
+</div>
 
-## Installation
+--------
+### instantOS is still in early beta, contributions always welcome
 
-*recommended*
+instantOS will be a distro based on manjaro, 
+but as of now, the components that are already functional can be installed on top of 
+an existing install of either arch or manjaro. 
 
+### Installation on top of an existing distro-install
+#### WARNING THIS WILL OVERRIDE ANY EXISTING CONFIGURATION
 ```sh
-curl https://raw.githubusercontent.com/paperbenni/suckless/master/install.sh | bash
-```
-### Installation including config files like .bashrc
-
-*Currently broken*
-
-#### WARNING THIS WILL OVERWRITE ANY EXISTING CONFIGURATION
-```sh
-curl https://raw.githubusercontent.com/paperbenni/dotfiles/master/install.sh | bash -s c
+curl -Ls https://git.io/JvIfw | sudo bash
 ```
+## Requirements:
+This requires xorg, it does NOT work with wayland as it relies on x utilities