Clearer Readme for Nixos Newbies

[CrystalKeck27]

I think that this is probably obvious to people who use nixos more often, but it tripped me up for a good couple hours.

If you want to use the newrelic-infra service, there is another step on top of the overlay.

{
  pkgs,
  lib,
  inputs,
  ...
}: {

  imports =
    [
      inputs.nix-relic.nixosModules.newrelic-infra
    ];
  
  nixpkgs = {
    overlays = [
      inputs.nix-relic.overlays.additions
    ];
  };


  services.newrelic-infra = {
    enable = true;
    configFile = ./newrelic-infra.yml;
  };
}

I just include this file in my flake.

It would be nice if the readme had the imports statement somewhere in it too, but even if this change isn't made. I hope this issue helps anyone struggling with this in the future.

Don't forget to specialArgs = { inherit inputs; } in your flake.nix too.

[DavSanchez]

Hi!

You're totally right, sorry! I'll fix the documentation.

BTW, infrastructure-agent is upstreamed to Nixpkgs, so chances are you can skip the overlay and use it directly! It's both in 24.11 and unstable.

[DavSanchez]

Hello @CrystalKeck27! Sorry for the delay in addressing this. I have added some changes to the documentation in #28. Feel free to make a review or suggest any changes. I'll merge this later on the weekend if there are no comments.

[CrystalKeck27]

Thank you for addressing this! The changes look good, feel free to close when the pr merges.