@undeemed/get-shit-done-codex 1.6.12 → 1.20.3

package/README.md

@@ -1,11 +1,12 @@
-# get-shit-done-codex (Codex CLI)
+# get-shit-done-codex (Codex CLI/Desktop)
 
-A meta-prompting, context engineering and spec-driven development system for [OpenAI Codex CLI](https://github.com/openai/codex).
+A meta-prompting, context engineering and spec-driven development system for [OpenAI Codex](https://github.com/openai/codex), including both CLI and Desktop.
 
 Fork of [get-shit-done](https://github.com/taches/get-shit-done) by TÂCHES, adapted for Codex CLI by [undeemed](https://github.com/undeemed).
 
 [![npm version](https://img.shields.io/npm/v/%40undeemed%2Fget-shit-done-codex?style=flat-square)](https://www.npmjs.com/package/@undeemed/get-shit-done-codex)
 [![License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](LICENSE)
+![npm Downloads](https://img.shields.io/npm/dt/@undeemed/get-shit-done-codex?style=flat-square)
 
 ## What This Does
 
@@ -18,7 +19,7 @@ get-shit-done-codex (GSD) solves context rot — the quality degradation that ha
 ## Installation
 
 ```bash
-npx @undeemed/get-shit-done-codex
+npx @undeemed/get-shit-done-codex@latest
 ```
 
 You'll be prompted to install globally (`~/.codex/`) or locally (`./`).
@@ -30,7 +31,33 @@ npx @undeemed/get-shit-done-codex --global   # Install to ~/.codex/
 npx @undeemed/get-shit-done-codex --local    # Install to current directory
 ```
 
-After installation, run `codex` to start Codex CLI, then use `/prompts:gsd-help` to see all commands.
+After installation, run `codex` (CLI) or `codex app` (Desktop), then use `/prompts:gsd-help` to see all commands.
+
+## Staying Updated
+
+```bash
+# Check for updates from inside Codex
+/prompts:gsd-update
+
+# Update from terminal
+npx @undeemed/get-shit-done-codex@latest --global
+```
+
+The installer now writes a `get-shit-done/VERSION` file so `/prompts:gsd-update` can detect installed vs latest and show changelog before updating.
+
+## npm Trusted Publisher (OIDC)
+
+This repo includes a GitHub Actions publish workflow at:
+
+- `.github/workflows/publish.yml`
+
+When setting up npm Trusted Publisher for this package, use:
+
+- **Publisher:** `GitHub Actions`
+- **Organization or user:** `undeemed`
+- **Repository:** `get-shit-done-codex`
+- **Workflow filename:** `publish.yml`
+- **Environment name:** leave blank (unless you later bind this workflow to a specific GitHub Environment)
 
 ## Quick Start
 
@@ -103,6 +130,7 @@ Manual user acceptance testing. The system walks you through testable deliverabl
 | `/prompts:gsd-complete-milestone`   | Archive milestone, tag release                                    |
 | `/prompts:gsd-new-milestone [name]` | Start next version                                                |
 | `/prompts:gsd-progress`             | Show current status and what's next                               |
+| `/prompts:gsd-update`               | Check npm for a newer release and apply update                    |
 | `/prompts:gsd-help`                 | Show all commands                                                 |
 
 See `/prompts:gsd-help` for the complete command reference.
@@ -154,6 +182,11 @@ Git bisect finds exact failing task. Each task independently revertable.
 npx @undeemed/get-shit-done-codex@latest
 ```
 
+**Can users be notified when an update is available?**
+- Yes. The installer prints an update notice if a newer npm version exists.
+- In-Codex update checks are available via `/prompts:gsd-update`.
+- For release notifications outside the CLI, enable GitHub release watching on this repo.
+
 ## More Documentation
 
 For deeper guides, detailed workflows, and comprehensive documentation, see the [original get-shit-done README](https://github.com/taches/get-shit-done/blob/main/README.md).
@@ -165,10 +198,10 @@ The original repository contains:
 - Best practices and examples
 - Architecture and design principles
 
-**Note:** The original README is written for Claude Code. When following it, remember that this fork uses:
+**Note:** The original README is written for Codex CLI. When following it, remember that this fork uses:
 - `/prompts:gsd-*` command format (instead of `/gsd:*`)
-- Codex CLI (instead of Claude Code)
-- `~/.codex/` directory (instead of `~/.claude/`)
+- Codex CLI (instead of Codex CLI)
+- `~/.codex/` directory (instead of `~/.codex/`)
 
 ## Credits