aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-09-15 19:06:13 -0700
committerFuwn <[email protected]>2024-09-15 19:06:13 -0700
commit28f09034dc2485e9bae90353c227768d93657cbc (patch)
tree0f8864b6deac5395c99cbd9f6e4deae43e019cac
parentc083af782c3c2144dfcdf87cbd19b0349b6ced52 (diff)
downloadrui-28f09034dc2485e9bae90353c227768d93657cbc.tar.xz
rui-28f09034dc2485e9bae90353c227768d93657cbc.zip
docs(readme): add usage instructions
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
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