Update README and some examples (#160)

README.md

@@ -6,6 +6,7 @@ to configure KDE Plasma using Nix.
 ## Table of contents
 - [What's supported](#whats-supported)
 - [What's not supported](#whats-not-well-supported-at-the-moment)
+- [What will not be supported](#what-will-not-be-supported)
 - [Getting started](#getting-started)
 - [Enabling declarative configuration](#make-your-configuration-more-declarative-with-overrideconfig)
 - [Capturing existing configuration](#capturing-your-current-configuration-with-rc2nix)
@@ -50,6 +51,11 @@ particular:
 There may also be more things we aren't aware of. If you find some other
 limitations don't hesitate to open an issue or submit a pr.
 
+## What will not be supported
+There are some things which are out of bounds for this project due to technical
+reasons. For example
+- SDDM configuration (requires root-privileges and thus not suited for a `home-manager` module)
+
 ## Getting started
 We provide some examples to help you get started. These are located in the
 [examples](./examples/) directory. Here you in particular can find:

examples/home.nix

@@ -34,10 +34,20 @@
       {
         location = "bottom";
         widgets = [
-          "org.kde.plasma.kickoff"
-          # We can also configure the widgets. For example if you want to pin
-          # konsole and dolphin to the task-launcher the following widget will
-          # have that.
+          # We can configure the widgets by adding the name and config
+          # attributes. For example to add the the kickoff widget and set the
+          # icon to "nix-snowflake-white" use the below configuration. This will
+          # add the "icon" key to the "General" group for the widget in
+          # ~/.config/plasma-org.kde.plasma.desktop-appletsrc.
+          {
+            name = "org.kde.plasma.kickoff";
+            config = {
+              General.icon = "nix-snowflake-white";
+            };
+          }
+          # Adding configuration to the widgets can also for example be used to
+          # pin apps to the task-manager, which this example illustrates by
+          # pinning dolphin and konsole to the task-manager by default.
           {
             name = "org.kde.plasma.icontasks";
             config = {
@@ -47,6 +57,8 @@
               ];
             };
           }
+          # If no configuration is needed, specifying only the name of the
+          # widget will add them with the default configuration.
           "org.kde.plasma.marginsseparator"
           "org.kde.plasma.systemtray"
           "org.kde.plasma.digitalclock"
@@ -86,13 +98,19 @@
     # Some low-level settings:
     #
     configFile = {
-      "baloofilerc"."Basic Settings"."Indexing-Enabled" = false;
-      "kwinrc"."org.kde.kdecoration2"."ButtonsOnLeft" = "SF";
-      "kwinrc"."Desktops"."Number" = {
+      baloofilerc."Basic Settings"."Indexing-Enabled" = false;
+      kwinrc."org.kde.kdecoration2".ButtonsOnLeft = "SF";
+      kwinrc.Desktops.Number = {
         value = 8;
         # Forces kde to not change this value (even through the settings app).
         immutable = true;
       };
+      kscreenlockerrc = {
+        Greeter.WallpaperPlugin = "org.kde.potd";
+        # To use nested groups use / as a separator. In the below example,
+        # Provider will be added to [Greeter][Wallpaper][org.kde.potd][General].
+        "Greeter/Wallpaper/org.kde.potd/General".Provider = "bing";
+      };
     };
   };
 }