From 28f09034dc2485e9bae90353c227768d93657cbc Mon Sep 17 00:00:00 2001 From: Fuwn Date: Sun, 15 Sep 2024 19:06:13 -0700 Subject: docs(readme): add usage instructions --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index ddfa2fa..54bff42 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,36 @@ directory. Rui looks at the `FLAKE_EDITOR` environment variable for the editor to use when opening the flake directory, but falls back to `EDITOR` if it isn't set. +## Installation + +### Add to Flake Inputs + +```nix +{ + inputs.rui = { + url = "github:Fuwn/rui"; + inputs.nixpkgs.follows = "nixpkgs"; # Recommended + }; +} +``` + +### Add to System or Home Manager Packages + +```nix +rui.packages.${pkgs.system}.default + +# or + +(import ( + pkgs.fetchFromGitHub { + owner = "Fuwn"; + repo = "rui"; + rev = "..."; # Use the current commit revision hash + hash = "..."; # Use the current commit sha256 hash + } +)).packages.${builtins.currentSystem}.default +``` + ## `--help` ```text -- cgit v1.2.3