feat: fixed documentation

[GaetanLepage]

I closed #497 by error.
cc @DockterTeagle

---

The documentation had a deprecated argument in the home-manager example by using configuration, this aims to fix that by providing an example of how to fix it in the current nixos unstable branch(which at the time of writting is 24.05), through a comment.

Fixes #496

[willruggiano]

While you're at it, can you please also update the documentation per my comment in #521

[GaetanLepage]

While you're at it, can you please also update the documentation per my comment in #521

Is that still relevant ?
The package should now build fine "no matter" what (unstable) channel people are using.
You want to warn them nonetheless that it is at their own risk to override the nixpkgs input of the overlay flake ?

[willruggiano]

While you're at it, can you please also update the documentation per my comment in #521

Is that still relevant ? The package should now build fine "no matter" what (unstable) channel people are using. You want to warn them nonetheless that it is at their own risk to override the nixpkgs input of the overlay flake ?

Still relevant, but probably worth a pinned github issue rather than in the README. I will do this. Note that "package should now build fine" is not technically correct, it entirely depends on what version of nixpkgs is being used. But I will drop these details into the github issue.