diff --git a/README.md b/README.md index 7b48c65..84d3e07 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # zsh-flake -A shrimple zsh dotfiles flake \ No newline at end of file +A shrimple personal zsh dotfiles flake :3 + +## Why? + +I'd like to use my zsh dotfiles on Non-NixOS systems and have them be systemwide, the current suggested way of configuring zsh with NixOS is by using home-manager and I was not very happy with that solution, this flake overrides the nixpkgs version of zsh to enable the use of it systemwide. + +## Installation + +### NixOS Configuration Installation + +```nix +programs.zsh.enable = true; + +nixpkgs.overlays = [ + # replace with the name of your input + .overlays.default +]; +``` + +### Testing + +```sh +$ nix run github:kosslan/zsh-flake +``` \ No newline at end of file