Add librepods package and update README for usage instructions

README.md

@@ -1,37 +1,47 @@
-# nur-packages-template
-
-**A template for [NUR](https://github.com/nix-community/NUR) repositories**
-
-## Setup
-
-1. Click on [Use this template](https://github.com/nix-community/nur-packages-template/generate) to start a repo based on this template. (Do _not_ fork it.)
-2. Add your packages to the [pkgs](./pkgs) directory and to
-   [default.nix](./default.nix)
-   * Remember to mark the broken packages as `broken = true;` in the `meta`
-     attribute, or travis (and consequently caching) will fail!
-   * Library functions, modules and overlays go in the respective directories
-3. Choose your CI: Depending on your preference you can use github actions (recommended) or [Travis ci](https://travis-ci.com).
-   - Github actions: Change your NUR repo name and optionally add a cachix name in [.github/workflows/build.yml](./.github/workflows/build.yml) and change the cron timer
-     to a random value as described in the file
-   - Travis ci: Change your NUR repo name and optionally your cachix repo name in 
-   [.travis.yml](./.travis.yml). Than enable travis in your repo. You can add a cron job in the repository settings on travis to keep your cachix cache fresh
-5. Change your travis and cachix names on the README template section and delete
-   the rest
-6. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository)
-
-## README template
-
 # nur-packages
 
-**My personal [NUR](https://github.com/nix-community/NUR) repository**
+Personal [NUR](https://github.com/nix-community/NUR) repository.
 
-<!-- Remove this if you don't use github actions -->
-![Build and populate cache](https://github.com/<YOUR-GITHUB-USER>/nur-packages/workflows/Build%20and%20populate%20cache/badge.svg)
+## Packages
 
-<!--
-Uncomment this if you use travis:
+- **librepods**: LibrePods Linux app (Qt6) — AirPods controls and battery monitoring.
+  - Upstream: `https://github.com/kavishdevar/librepods`
 
-[![Build Status](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages.svg?branch=master)](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages)
--->
-[![Cachix Cache](https://img.shields.io/badge/cachix-<YOUR_CACHIX_CACHE_NAME>-blue.svg)](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org)
+## Usage
+
+See the official NUR installation docs: [NUR documentation – Installation](https://nur.nix-community.org/documentation/#installation).
+
+### Usage (flakes)
+
+If you want to use this repo directly as a flake input:
+
+```nix
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    my-nur.url = "github:<YOUR_GITHUB_USER>/nur-packages";
+  };
+
+  outputs = { self, nixpkgs, my-nur, ... }:
+    let
+      system = "x86_64-linux";
+      pkgs = import nixpkgs {
+        inherit system;
+        overlays = [ my-nur.overlays.default ];
+      };
+    in
+    {
+      packages.${system}.default = pkgs.librepods;
+    };
+}
+```
+
+### Usage (local build/test)
+
+From this repository:
+
+```bash
+nix build .#librepods
+./result/bin/librepods
+```