Add missing descriptions

README.md

@@ -1,6 +1,13 @@
-# The Determinate flake checker Action
+# flake-checker-action
 
-Here's an example configuration:
+The `flake-checker-action` from [Determinate Systems][ds] performs health checks on your repos' [`flake.lock`][lock] files.
+Specifically, it checks that your root [Nixpkgs] input:
+
+* Was updated within the last 30 days
+* Has the [`NixOS`][nixos-org] GitHub org as its owner
+* Is from a supported Git branch
+
+Here's an example configuration that uses `flake-checker-action` as part of a broader Actions workflow involving Nix.
 
 ```yaml
 on:
@@ -15,10 +22,14 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Check Nix flake inputs
-        uses: DeterminateSystems/flake-checker-action@v1
+        uses: DeterminateSystems/flake-checker-action@v1 # This action
       - name: Install Nix
         uses: DeterminateSystems/nix-installer-action@v3
       - name: Build default package
-        run: |
-          nix build
+        run: nix build
 ```
+
+[ds]: https://determinate.systems
+[lock]: https://zero-to-nix.com/concepts/flakes#lockfile
+[nixos-org]: https://github.com/NixOS
+[nixpkgs]: https://github.com/NixOS/nixpkgs

action.yml

@@ -1,28 +1,38 @@
 name: The Determinate Systems flake checker
-description: TODO
+description: |
+  A GitHub Action that performs health checks on your `flake.lock` file
 branding:
   icon: "box"
   color: "purple"
 inputs:
   flake-lock-path:
-    description: TODO
+    description: |
+      The path to the `flake.lock` file you want to check.
     default: flake.lock
   send-statistics:
     description: |
-      Anonymously report the number issues detected by the flake checker, which helps
+      Anonymously report the number of issues detected by the flake checker. This reporting helps
       measure the effectiveness of the flake checker. Set to `false` to disable.
     default: true
   check-outdated:
-    description: TODO
+    description: |
+      Whether to check that the root Nixpkgs input is less than 30 days old.
     default: true
   check-owner:
-    description: TODO
+    description: |
+      Whether to check that the root Nixpkgs input has the `NixOS` GitHub org as its owner.
     default: true
   check-supported:
-    description: TODO
+    description: |
+      Whether to check that the root Nixpkgs input has a supported Git ref. Currently supported
+      ref: `nixos-22.11`, `nixos-22.11-small`, `nixos-23.05`, `nixos-23.05-small`, `nixos-unstable`,
+      `nixos-unstable-small`, `nixpkgs-22.11-darwin`, `nixpkgs-23.05-darwin`, `nixpkgs-unstable`.
     default: true
   ignore-missing-flake-lock:
-    description: TODO
+    description: |
+      Whether to ignore a missing `flake.lock` file, where the path to the file is the value of
+      `flake-lock-path` parameter. If set to `false` (the default is `true`), the Action throws
+      an error if the lockfile is missing.
     default: true
 runs:
   using: composite
@@ -32,7 +42,7 @@ runs:
       run: |
         (
           set -eu
-          
+
           curl --max-time 2 --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/flake-checker/stable/$RUNNER_ARCH-$RUNNER_OS > "$RUNNER_TEMP/flake-checker"
           chmod +x "$RUNNER_TEMP/flake-checker"