aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorvaxerski <[email protected]>2022-03-20 18:02:20 +0100
committervaxerski <[email protected]>2022-03-20 18:02:20 +0100
commit600c32b0d425d7c23c2810225a17708f95938698 (patch)
tree7f977abc6f6a072664989054500403b16e4e1725 /README.md
parent3b827a14b6eab62c3a7bf1eb6f041c68bca1abba (diff)
downloadHyprland-600c32b0d425d7c23c2810225a17708f95938698.tar.gz
Hyprland-600c32b0d425d7c23c2810225a17708f95938698.zip
update readme and config
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 47 insertions, 3 deletions
diff --git a/README.md b/README.md
index a9fa1364..2af58e59 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,51 @@
# Hyprland
-
-Hyprland is a Dynamic Tiling Wayland Compositor taking on some innovative and *groovin'* ideas. It's written fully in C++.
+*logo is a to-do :P*<br/>
+![Issues](https://img.shields.io/github/issues/vaxerski/Hyprland)
+![PRs](https://img.shields.io/github/issues-pr/vaxerski/Hyprland)
+![Lang](https://img.shields.io/github/languages/top/vaxerski/Hyprland)
+![License](https://img.shields.io/github/license/vaxerski/Hyprland)
+![Best](https://img.shields.io/badge/Standard-C%2B%2B20-success)
+![HiMom](https://img.shields.io/badge/Hi-mom!-ff69b4)
+<br/><br/>
+Hyprland is a Dynamic Tiling Wayland Compositor in early development stages.
For Hyprland without the land part, see [Hypr](https://github.com/vaxerski/Hypr), the Xorg window manager.
-VERY early dev. And I mean VERY. It's yet to be really usable, but I am developing it! \ No newline at end of file
+WARNING!
+Hyprland is in very early dev, expect bugs, instabilities and crashes. You have been warned!
+Nevertheless, REPORT any you find! Make an issue!
+<br/>
+
+# Key features
+ - Config reloaded instantly upon saving
+ - Easily expandable and readable codebase
+ - Support for docks/whatever
+ - Monitor rules
+ - Tiling/floating windows
+ - Moving/resizing windows
+<br/>
+
+# Major to-dos
+ - Animations
+ - Rounded corners
+ - Blur
+ - Window rules
+ - STABILITY
+<br/>
+
+# Installation
+Please refer to the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Installation)
+<br/>
+
+# Configuring
+Head onto the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland) to see more.
+
+Hyprland without a config is a bad idea!
+<br/>
+
+# Gallery
+![Image1](https://i.imgur.com/SIPepse.png)
+<br/>
+
+# Contributions
+Welcome, I'll make a CONTRIBUTING.md some time in the future.