From abff71b7affde61ca8f51327a23d2973024dd326 Mon Sep 17 00:00:00 2001
From: Lev Babiev <crion@crion.no-ip.org>
Date: Thu, 24 Dec 2020 21:41:07 +0000
Subject: [PATCH] update README.me

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a81e3c8b..aea554b1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
-# sfwbar
-Sway Floating Window Bar
+### SFWBar
+
+SFWBar (Sway Floating Window Bar) is a flexible taskbar application for 
+[Sway](https://github.com/swaywm/sway) wayland
+compositor, designed with a stacking layout in mind. 
+
+## SFWBar implements the following features:
+1. Taskbar - to control floating windows
+1. Window placement engine - to open new windows in more logical locations
+1. A simple widget set to display information from system files
+
+## Compiling from Source
+
+Install dependencies:
+glib
+gtk3
+gtk-layer-shell
+json-c
+
+Compile instructions:
+meson build
+ninja -C build
+
+## Configuration
+See man page for config file details