Merge pull request #231 from serokell/rvem/#201-dont-hardcode-profile-directory

[#201] Deduce profile directory during activation

1 files changed, 5 insertions, 2 deletions

diff --git a/README.md b/README.md
index aff46f9..a5beaf8 100644
--- a/README.md
+++ b/README.md
@@ -125,8 +125,11 @@ This is the core of how `deploy-rs` was designed, any number of these can run on
   path = deploy-rs.lib.x86_64-linux.activate.custom pkgs.hello "./bin/hello";
 
   # An optional path to where your profile should be installed to, this is useful if you want to use a common profile name across multiple users, but would have conflicts in your node's profile list.
-  # This will default to `"/nix/var/nix/profiles/$PROFILE_NAME` if `user` is root (see: generic options), and `/nix/var/nix/profiles/per-user/$USER/$PROFILE_NAME` if it is not.
-  profilePath = "/nix/var/nix/profiles/per-user/someuser/someprofile";
+  # This will default to `"/nix/var/nix/profiles/system` if `user` is `root` and profile name is `system`,
+  # `/nix/var/nix/profiles/per-user/root/$PROFILE_NAME` if profile name is different.
+  # For non-root profiles will default to /nix/var/nix/profiles/per-user/$USER/$PROFILE_NAME if `/nix/var/nix/profiles/per-user/$USER` already exists,
+  # and `${XDG_STATE_HOME:-$HOME/.local/state}/nix/profiles/$PROFILE_NAME` otherwise.
+  profilePath = "/home/someuser/.local/state/nix/profiles/someprofile";
 
   # ...generic options... (see lower section)
 }