README: update documentation, move it to alpha status

README.md

@@ -2,8 +2,36 @@
 
 [![Go](https://github.com/thiagokokada/hyprland-go/actions/workflows/go.yml/badge.svg)](https://github.com/thiagokokada/hyprland-go/actions/workflows/go.yml)
 [![Test](https://github.com/thiagokokada/hyprland-go/actions/workflows/nix.yaml/badge.svg)](https://github.com/thiagokokada/hyprland-go/actions/workflows/nix.yaml)
+[![Hyprland](https://img.shields.io/badge/Made%20for-Hyprland-blue)](https://github.com/hyprwm/Hyprland)
+[![stability-alpha](https://img.shields.io/badge/stability-alpha-f4d03f.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#alpha)
 
-An unofficial Go wrapper for Hyprland's IPC. Very WIP.
+An unofficial Go wrapper for Hyprland's IPC.
+
+## Getting started
+
+```
+go get -u github.com/thiagokokada/hyprland-go
+```
+
+Look at the `examples` directory for examples on how to use the library.
+
+## What is supported?
+
+- [Dispatchers:](https://wiki.hyprland.org/Configuring/Dispatchers/) for
+  calling dispatchers, batch mode supported, e.g.: `c.Dispatch("exec kitty",
+  "exec firefox")`
+- [Keywords:](https://wiki.hyprland.org/Configuring/Keywords/) for dealing with
+  configuration options, e.g.: (`c.SetKeyword("bind SUPER,Q,exec,firefox",
+  "general:border_size 1")`)
+- [Hyprctl commands:](https://wiki.hyprland.org/Configuring/Using-hyprctl/)
+  most commands are supported, e.g.: `c.SetCursor("Adwaita",
+  32)`.
+  + Commands that returns a JSON in `hyprctl -j` will return a proper struct,
+    e.g.: `c.ActiveWorkspace().Monitor`
+
+## Planned
+
+- [Events](https://wiki.hyprland.org/Plugins/Development/Event-list/)
 
 ## Credits