From 55d04eb66e20e3313d1165b76725f235ebbfa83f Mon Sep 17 00:00:00 2001
From: Spencer Brower <brower.spencer@gmail.com>
Date: Sat, 3 Feb 2024 22:57:33 -0500
Subject: [PATCH] docs: Improved `README.md`.

---
 Makefile                   |  7 ++++++
 README.md                  | 30 +++++++++++++++++++++++++-
 README.md.tmpl             | 44 ++++++++++++++++++++++++++++++++++++++
 ffprobe                    |  2 +-
 flake.lock                 |  6 +++---
 flake.nix                  |  3 +--
 get_ffprobe_commands_table | 15 +++++++++++++
 get_filter_support_table   | 13 +++++++++++
 8 files changed, 113 insertions(+), 7 deletions(-)
 create mode 100644 Makefile
 create mode 100644 README.md.tmpl
 create mode 100755 get_ffprobe_commands_table
 create mode 100755 get_filter_support_table

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..8427141
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,7 @@
+README.md:
+	gomplate -f $@.tmpl --plugin 'filters=./get_filter_support_table,ffprobe=./get_ffprobe_commands_table' > $@
+
+clean:
+	rm README.md
+
+.PHONY: clean
diff --git a/README.md b/README.md
index a3af43b..b0d621e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,4 @@
+
 # nu-ffmpeg
 
 Utility commands for working with ffmpeg in nushell.
@@ -15,7 +16,7 @@ Utility commands for working with ffmpeg in nushell.
 The `ffmpeg` and `ffprobe` commands are required to be installed and available
 in your path; they are not installed for you.
 
-Currently nushell versions 0.87.0 - 0.88.1 are supported.
+Currently only nushell version 0.89.0 is supported.
 
 After that, clone this repository and add the following code to your scripts,
 or to your `config.nu` file:
@@ -24,3 +25,30 @@ or to your `config.nu` file:
 use <path-to-repository>/ffprobe
 use <path-to-repository>/filters *
 ```
+
+## FFProbe
+
+### Commands
+
+| name                  | usage                                                            |
+| --------------------- | ---------------------------------------------------------------- |
+| ffprobe               | Run ffprobe on a list of files and return the output as a table. |
+| ffprobe dimensions    | Get the dimensions of a video stream                             |
+| ffprobe streams       | Retrieve all the streams from a list of ffprobe outputs          |
+| ffprobe streams audio | Retrieve all the audio streams from a list of ffprobe outputs    |
+| ffprobe streams video | Retrieve all the video streams from a list of ffprobe outputs    |
+
+
+## FFMpeg
+
+## Supported Filters
+
+| name    | usage                                                                                              |
+| ------- | -------------------------------------------------------------------------------------------------- |
+| crop    | Crop the input video to given dimensions.                                                          |
+| fps     | Convert the video to specified constant frame rate by duplicating or dropping frames as necessary. |
+| loop    | loop video frames                                                                                  |
+| overlay | Overlay one video on top of another.                                                               |
+| split   |                                                                                                    |
+| vflip   | Flip the input video vertically.                                                                   |
+
diff --git a/README.md.tmpl b/README.md.tmpl
new file mode 100644
index 0000000..b83b4c0
--- /dev/null
+++ b/README.md.tmpl
@@ -0,0 +1,44 @@
+{{ if false }}
+<!--
+vim: filetype=markdown :
+->
+
+{{ end }}
+# nu-ffmpeg
+
+Utility commands for working with ffmpeg in nushell.
+
+## Capabilities
+
+- Return tables from `ffprobe`
+- `ffprobe` multiple files at once
+- Use `streams`, `streams video`, and `streams audio` to filter `ffprobe` output
+- get the `dimensions` of a video stream as a record
+- Apply and parse complex filters to a video (Work In Progress)
+
+## Setup
+
+The `ffmpeg` and `ffprobe` commands are required to be installed and available
+in your path; they are not installed for you.
+
+Currently only nushell version 0.89.0 is supported.
+
+After that, clone this repository and add the following code to your scripts,
+or to your `config.nu` file:
+
+```nu
+use <path-to-repository>/ffprobe
+use <path-to-repository>/filters *
+```
+
+## FFProbe
+
+### Commands
+
+{{ ffprobe }}
+
+## FFMpeg
+
+## Supported Filters
+
+{{ filters }}
diff --git a/ffprobe b/ffprobe
index b2be615..7e0435b 100755
--- a/ffprobe
+++ b/ffprobe
@@ -1,7 +1,7 @@
 #!/usr/bin/env nu
 # vim: filetype=nu :
 
-# Multimedia stream analyzer.
+# Run ffprobe on a list of files and return the output as a table.
 export def main [
   ...input_files: string
 ]: nothing -> table {
diff --git a/flake.lock b/flake.lock
index a09cdfa..0716ea3 100644
--- a/flake.lock
+++ b/flake.lock
@@ -2,11 +2,11 @@
   "nodes": {
     "nixpkgs": {
       "locked": {
-        "lastModified": 1704538339,
-        "narHash": "sha256-1734d3mQuux9ySvwf6axRWZRBhtcZA9Q8eftD6EZg6U=",
+        "lastModified": 1705856552,
+        "narHash": "sha256-JXfnuEf5Yd6bhMs/uvM67/joxYKoysyE3M2k6T3eWbg=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "46ae0210ce163b3cba6c7da08840c1d63de9c701",
+        "rev": "612f97239e2cc474c13c9dafa0df378058c5ad8d",
         "type": "github"
       },
       "original": {
diff --git a/flake.nix b/flake.nix
index 1496599..9d0ea84 100644
--- a/flake.nix
+++ b/flake.nix
@@ -13,8 +13,7 @@
       devShells.x86_64-linux.default = pkgs.mkShell {
         packages = with pkgs; [
           ffmpeg
-
-          sbcl
+          gomplate
 
           nushellFull
         ];
diff --git a/get_ffprobe_commands_table b/get_ffprobe_commands_table
new file mode 100755
index 0000000..bfb83c3
--- /dev/null
+++ b/get_ffprobe_commands_table
@@ -0,0 +1,15 @@
+#!/usr/bin/env -S nu -n
+# vim: filetype=nu :
+
+use ffprobe;
+
+def main [] {
+  (
+    help commands
+    | where command_type == "custom" and name !~ "p(rompt|wd)"
+    | select name usage
+    | update name { if $in == 'main' { 'ffprobe' } else { $'ffprobe ($in)' } }
+    | filter { not ($in.name == 'ffprobe' and ($in.usage | is-empty)) }
+    | to md -p
+  )
+}
diff --git a/get_filter_support_table b/get_filter_support_table
new file mode 100755
index 0000000..03a0313
--- /dev/null
+++ b/get_filter_support_table
@@ -0,0 +1,13 @@
+#!/usr/bin/env -S nu -n
+# vim: filetype=nu :
+
+use filters.nu;
+
+def main [] {
+  (
+    help commands
+    | where command_type == "custom" and name !~ "p(rompt|wd)|^main$"
+    | select name usage
+    | to md -p
+  )
+}