aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-09-16 19:05:27 -0700
committerFuwn <[email protected]>2024-09-16 19:05:27 -0700
commitace2bad8b940d08c5afaca1e88b3bd21d8ddf7f4 (patch)
tree293fc54b95f147707e614031eac87be981277082 /README.md
parentfeat: initial release (diff)
downloadtsutsumi-ace2bad8b940d08c5afaca1e88b3bd21d8ddf7f4.tar.xz
tsutsumi-ace2bad8b940d08c5afaca1e88b3bd21d8ddf7f4.zip
docs(readme): add installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3ebf264..c4611c9 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,36 @@
- [Yaak](https://yaak.app/) - The API client for modern developers
- [Zen Browser](https://zen-browser.app/)
+## Installation
+
+### Add to Flake Inputs (for Flakes Users)
+
+```nix
+{
+ inputs.tsutsumi = {
+ url = "github:Fuwn/tsutsumi";
+ inputs.nixpkgs.follows = "nixpkgs"; # Recommended
+ };
+}
+```
+
+### Add to System or Home Manager Packages
+
+```nix
+# For flakes users
+tsutsumi.packages.${pkgs.system}.rui # Or any other package
+
+# For non-flakes users
+(import (
+ pkgs.fetchFromGitHub {
+ owner = "Fuwn";
+ repo = "tsutsumi";
+ rev = "..."; # Use the current commit revision hash
+ hash = "..."; # Use the current commit sha256 hash
+ }
+)).packages.${builtins.currentSystem}.rui # Or any other package
+```
+
## Credits
This flake includes a modified version of