diff --git a/README.md b/README.md index 49f46a8..9c6ffc5 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@
@@ -36,20 +36,136 @@
## Usage
-1. Clone this repository locally
-2. Open the app's settings
-3. Select `import theme` and browse to where you cloned Catppuccin
-4. Select it
+1. Import the [NixOS](https://nixos.org) and [home-manager](https://github.com/nix-community/home-manager) modules
+
+With Flakes
+
+```nix
+{
+ inputs = {
+ nixpkgs.url = "nixpkgs/nixos-22.11";
+ catppuccin.url = "github:catppuccin/nix";
+ home-manager = {
+ url = "github:nix-community/home-manager";
+ inputs.nixpkgs.follows = "nixpkgs";
+ };
+ };
+
+ outputs = { nixpkgs, catppuccin, home-manager }: let
+ system = "x86_64-linux";
+ pkgs = import nixpkgs {inherit system;};
+ in {
+ # for nixos module home-manager installations
+ nixosConfigurations.host = pkgs.lib.nixosSystem {
+ inherit system;
+ modules = [
+ catppuccin.nixosModules.catppuccin
+ home-manager.nixosModules.home-manager
+ {
+ home-manager.users.user = {
+ modules = [
+ catppuccin.homeManagerModules.catppuccin
+ ];
+ };
+ }
+ ];
+ };
+
+ # for standalone home-manager installations
+ homeConfigurations.user = home-manager.lib.homeManagerConfiguration {
+ inherit pkgs;
+ modules = [
+ catppuccin.homeManagerModules.catppuccin
+ ];
+ };
+ };
+}
+```
+
+With Nix Channels
+
+```bash
+sudo nix-channel --add https://github.com/nix-community/home-manager/archive/master.tar.gz home-manager
+sudo nix-channel --add https://github.com/catppuccin/nix/archive/main.tar.gz catppuccin
+sudo nix-channel --update
+```
+
+For [NixOS module installations](https://nix-community.github.io/home-manager/index.html#sec-install-nixos-module):
+
+```nix
+_: {
+ imports = [
+ Example
+
+```nix
+_: {
+ catppuccin.flavour = "mocha";
+}
+```
+
+Example
+
+```nix
+_: {
+ programs.starship = {
+ enable = true;
+ catppuccin.enable = true;
+ };
+}
+```
+
+