feat: initial README.md

README.md

@@ -1 +1,30 @@
-# Aerospike Gnome (Tiling Window Manager)
+# Aerospike Gnome (Tiling Window Manager)
+
+Aerospike is a simple and opinionated tiling window manager for gnome.
+
+This project takes inspiration from previous gnome tiling window managers such
+as [forge](https://github.com/forge-ext/forge)
+and [cosmic-shell](https://github.com/pop-os/gnome-shell-extension-pop-cosmic) as well as
+MacOS tiling WMs, mainly [Aerospace](https://github.com/nikitabobko/AeroSpace) (not affiliated).
+
+## Current Features
+
+- Auto-tiling
+- Accordion layouts with variable sizes
+- Tabbed layouts
+- Tree-based (albeit set depth of 2 for now) container-window paired layout similar to Aerospace
+- Diagram for this is pending
+
+## Planned functionality
+
+- Full Keyboard control w/window movement
+- Sub-containers (more tree layers than the 1 supported for now)
+- Gap size customization
+
+## Not currently planned
+
+- Active window borders
+    - See my other extension for a rainbow or static border - [PrettyBorders](https://github.com//pretty-borders)
+- complicated window dragging features and uis
+    - Aerospace supports control + drag to combine windows while moving with the mouse, and normal window dragging.
+

package.json

@@ -9,7 +9,7 @@
     "url": "git+https://gitlab.com/lucasoskorep/aerospike"
   },
   "author": "Lucas Oskorep <lucas.oskorep@gmail.com>",
-  "license": "LGPL-3.0-or-later",
+  "license": "GPL-3.0-only",
   "bugs": {
     "url": "https://github.com/example/my-extension/issues"
   },