add flake-compat, fixup some issues, update docs

default.nix

@@ -1,4 +1,7 @@
-{ pkgs ? import <nixpkgs> { }, system ? pkgs.system }:
+{ _compat ? import ./flake-compat.nix
+, pkgs ? import _compat.inputs.nixpkgs { }
+, system ? pkgs.system
+}:
 let
   params = { inherit pkgs system; };
   pog = import ./pog params;

docs/basic-examples.md

@@ -1,5 +1,44 @@
-## basic examples
+# basic examples
+
+## github tags fetcher
 
 ```nix
-TODO
+github_tags = pog.pog {
+  name = "github_tags";
+  description = "a nice wrapper for getting github tags for a repo!";
+  flags = [
+    {
+      name = "latest";
+      description = "fetch only the latest tag";
+      bool = true;
+    }
+    pog._.flags.github.owner
+    pog._.flags.github.repo
+  ];
+  script = helpers: ''
+    tags="$(${pog._.curl} -Ls "https://api.github.com/repos/''${owner}/''${repo}/tags" |
+      ${pkgs.lib.getExe pkgs.jaq} -r '.[].name')"
+    if ${helpers.flag "latest"}; then
+      echo "$tags" | ${pog._.head} -n 1
+    else
+      echo "$tags"
+    fi
+  '';
+};
+```
+
+### generated docs
+
+```bash
+Usage: github_tags [-l|--latest] [-o|--owner VAR] [-r|--repo VAR]
+
+a nice wrapper for getting github tags for a repo!
+
+Flags:
+-l, --latest          fetch only the latest tag [bool]
+-o, --owner           the github user or organization that owns the repo [will prompt if not passed in]
+-r, --repo            the github repo to pull tags from [will prompt if not passed in]
+-h, --help            print this help and exit
+-v, --verbose         enable verbose logging and info
+--no-color            disable color and other formatting
 ```

docs/getting-started.md

@@ -1,3 +1,5 @@
+# Getting Started
+
 ## fetchTarball + import
 
 ```nix

docs/index.md

@@ -18,7 +18,7 @@ features:
     title: Pure Nix Power
     details: Create comprehensive CLI tools using pure Nix, leveraging the vast nixpkgs ecosystem
   - icon: 📖
-    title: Auto-Documentation
+    title: Automatic Documentation
     details: Automatic help text generation, documentation, and tab completion out of the box
   - icon: 🎯
     title: Rich Flag System

flake-compat.nix

@@ -0,0 +1,9 @@
+let
+  inherit (builtins) fromJSON readFile;
+  lock = fromJSON (readFile ./flake.lock);
+  flake-compat = with lock.nodes.flake-compat.locked; import (fetchTarball {
+    url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz";
+    sha256 = narHash;
+  });
+in
+(flake-compat { src = ./.; }).defaultNix

flake.nix

@@ -2,6 +2,10 @@
   description = "pog";
   inputs = {
     nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    flake-compat = {
+      flake = false;
+      url = "github:edolstra/flake-compat";
+    };
     flake-utils.url = "github:numtide/flake-utils";
   };