diff --git a/README.md b/README.md index 9405996..6bcac88 100644 --- a/README.md +++ b/README.md @@ -44,3 +44,38 @@ Many of the extra settings can be added to or overridden. # not recommended for a global config for obvious reasons. nixowos.cli.yt-dlp.extraConfig = "--extract-audio"; ``` + +## Example flake + +```nix +{ + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + + nixowos = { + url = "git+https://codeberg.org/electria/nixowos"; + flake = false; + }; + }; + outputs = + { nixpkgs, nixowos, ... }: + { + # NOTE: 'nixos' is the default hostname + nixosConfigurations.nixos = nixpkgs.lib.nixosSystem { + modules = [ + ./configuration.nix + ./hardware-configuration.nix + + "${nixowos}/default.nix" + { + nixowos.enable = true; + nixowos.graphical.enable = true; + nixowos.graphical.games.enable = true; + nixowos.graphical.plasma.startOnFirstTTY = true; + nixowos.graphical.jp.enable = true; + } + ]; + }; + }; +} +```