diff --git a/Getting-started.md b/Getting-started.md index 480adb5..927ffa3 100644 --- a/Getting-started.md +++ b/Getting-started.md @@ -1,3 +1,28 @@ +Pypr consists in two things: + +- **a tool**: `pypr` +- **some config file**: `~/.config/hypr/pyprland.json` + +The `pypr` tool only have two built-in commands: + +- `reload` reads the configuration file and attempt to apply the changes +- `--help` lists available commands (including plugins commands) + +Other commands are added by adding plugins. + +The config file uses the following syntax: + +```json +{ + "pyprland": { + "plugins": ["plugin_name"] + }, + "plugin_name": { + "plugin_option": 42 + } +} +``` + ## Installation Use the python package manager: