Feature/51

[malikwirin]

Summary

This PR implements the feature request from #51 by providing a Nix overlay that makes all Charmbracelet packages available directly in nixpkgs.

Closes #51

Changes

Overlay Implementation

• Added a functional overlays.default export that integrates all packages into nixpkgs
• Removed the old overlay.nix in favor of a cleaner implementation in overlays/default.nix
• Exposed overlays via flake.nix for seamless flake integration

Package Structure Refactoring

• Centralized package definitions in a new pkgs/default.nix
• Updated default.nix to import packages from the centralized location
• Updated module references to use the new package structure

Documentation

• Completely restructured and expanded the README with:
  • Multiple usage paths (NUR, Overlay, Direct Flake Reference)
  • Clear examples for NixOS and Home Manager integration
  • Added list of all available packages
  • Improved formatting and organization

Usage

After this change, users can apply the overlay to use packages directly:

{
  inputs.charmbracelet.url = "github:charmbracelet/nur";

  outputs = { self, nixpkgs, charmbracelet, ... }: {
    nixosConfigurations.example = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [{
        nixpkgs.overlays = [ charmbracelet.overlays.default ];
        environment.systemPackages = [ pkgs.gum pkgs.glow pkgs.mods ];
      }];
    };
  };
}

---

• I have read CONTRIBUTING.md.